Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string
}

    You do not have sufficient access to perform this action.

    func (*AccessDeniedException) Error

    func (e *AccessDeniedException) Error() string

    func (*AccessDeniedException) ErrorCode

    func (e *AccessDeniedException) ErrorCode() string

    func (*AccessDeniedException) ErrorFault

    func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

    func (*AccessDeniedException) ErrorMessage

    func (e *AccessDeniedException) ErrorMessage() string

    type AnalyzedResource

    type AnalyzedResource struct {
    
    	// The time at which the resource was analyzed.
    	//
    	// This member is required.
    	AnalyzedAt *time.Time
    
    	// The time at which the finding was created.
    	//
    	// This member is required.
    	CreatedAt *time.Time
    
    	// Indicates whether the policy that generated the finding grants public access to
    	// the resource.
    	//
    	// This member is required.
    	IsPublic *bool
    
    	// The ARN of the resource that was analyzed.
    	//
    	// This member is required.
    	ResourceArn *string
    
    	// The AWS account ID that owns the resource.
    	//
    	// This member is required.
    	ResourceOwnerAccount *string
    
    	// The type of the resource that was analyzed.
    	//
    	// This member is required.
    	ResourceType ResourceType
    
    	// The time at which the finding was updated.
    	//
    	// This member is required.
    	UpdatedAt *time.Time
    
    	// The actions that an external principal is granted permission to use by the
    	// policy that generated the finding.
    	Actions []string
    
    	// An error message.
    	Error *string
    
    	// Indicates how the access that generated the finding is granted. This is
    	// populated for Amazon S3 bucket findings.
    	SharedVia []string
    
    	// The current status of the finding generated from the analyzed resource.
    	Status FindingStatus
    }

      Contains details about the analyzed resource.

      type AnalyzedResourceSummary

      type AnalyzedResourceSummary struct {
      
      	// The ARN of the analyzed resource.
      	//
      	// This member is required.
      	ResourceArn *string
      
      	// The AWS account ID that owns the resource.
      	//
      	// This member is required.
      	ResourceOwnerAccount *string
      
      	// The type of resource that was analyzed.
      	//
      	// This member is required.
      	ResourceType ResourceType
      }

        Contains the ARN of the analyzed resource.

        type AnalyzerStatus

        type AnalyzerStatus string

        func (AnalyzerStatus) Values

        func (AnalyzerStatus) Values() []AnalyzerStatus

          Values returns all known values for AnalyzerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

          type AnalyzerSummary

          type AnalyzerSummary struct {
          
          	// The ARN of the analyzer.
          	//
          	// This member is required.
          	Arn *string
          
          	// A timestamp for the time at which the analyzer was created.
          	//
          	// This member is required.
          	CreatedAt *time.Time
          
          	// The name of the analyzer.
          	//
          	// This member is required.
          	Name *string
          
          	// The status of the analyzer. An Active analyzer successfully monitors supported
          	// resources and generates new findings. The analyzer is Disabled when a user
          	// action, such as removing trusted access for IAM Access Analyzer from AWS
          	// Organizations, causes the analyzer to stop generating new findings. The status
          	// is Creating when the analyzer creation is in progress and Failed when the
          	// analyzer creation has failed.
          	//
          	// This member is required.
          	Status AnalyzerStatus
          
          	// The type of analyzer, which corresponds to the zone of trust chosen for the
          	// analyzer.
          	//
          	// This member is required.
          	Type Type
          
          	// The resource that was most recently analyzed by the analyzer.
          	LastResourceAnalyzed *string
          
          	// The time at which the most recently analyzed resource was analyzed.
          	LastResourceAnalyzedAt *time.Time
          
          	// The statusReason provides more details about the current status of the analyzer.
          	// For example, if the creation for the analyzer fails, a Failed status is
          	// displayed. For an analyzer with organization as the type, this failure can be
          	// due to an issue with creating the service-linked roles required in the member
          	// accounts of the AWS organization.
          	StatusReason *StatusReason
          
          	// The tags added to the analyzer.
          	Tags map[string]string
          }

            Contains information about the analyzer.

            type ArchiveRuleSummary

            type ArchiveRuleSummary struct {
            
            	// The time at which the archive rule was created.
            	//
            	// This member is required.
            	CreatedAt *time.Time
            
            	// A filter used to define the archive rule.
            	//
            	// This member is required.
            	Filter map[string]Criterion
            
            	// The name of the archive rule.
            	//
            	// This member is required.
            	RuleName *string
            
            	// The time at which the archive rule was last updated.
            	//
            	// This member is required.
            	UpdatedAt *time.Time
            }

              Contains information about an archive rule.

              type ConflictException

              type ConflictException struct {
              	Message *string
              
              	ResourceId   *string
              	ResourceType *string
              }

                A conflict exception error.

                func (*ConflictException) Error

                func (e *ConflictException) Error() string

                func (*ConflictException) ErrorCode

                func (e *ConflictException) ErrorCode() string

                func (*ConflictException) ErrorFault

                func (e *ConflictException) ErrorFault() smithy.ErrorFault

                func (*ConflictException) ErrorMessage

                func (e *ConflictException) ErrorMessage() string

                type Criterion

                type Criterion struct {
                
                	// A "contains" operator to match for the filter used to create the rule.
                	Contains []string
                
                	// An "equals" operator to match for the filter used to create the rule.
                	Eq []string
                
                	// An "exists" operator to match for the filter used to create the rule.
                	Exists *bool
                
                	// A "not equals" operator to match for the filter used to create the rule.
                	Neq []string
                }

                  The criteria to use in the filter that defines the archive rule.

                  type Finding

                  type Finding struct {
                  
                  	// The time at which the resource was analyzed.
                  	//
                  	// This member is required.
                  	AnalyzedAt *time.Time
                  
                  	// The condition in the analyzed policy statement that resulted in a finding.
                  	//
                  	// This member is required.
                  	Condition map[string]string
                  
                  	// The time at which the finding was generated.
                  	//
                  	// This member is required.
                  	CreatedAt *time.Time
                  
                  	// The ID of the finding.
                  	//
                  	// This member is required.
                  	Id *string
                  
                  	// The AWS account ID that owns the resource.
                  	//
                  	// This member is required.
                  	ResourceOwnerAccount *string
                  
                  	// The type of the resource reported in the finding.
                  	//
                  	// This member is required.
                  	ResourceType ResourceType
                  
                  	// The current status of the finding.
                  	//
                  	// This member is required.
                  	Status FindingStatus
                  
                  	// The time at which the finding was updated.
                  	//
                  	// This member is required.
                  	UpdatedAt *time.Time
                  
                  	// The action in the analyzed policy statement that an external principal has
                  	// permission to use.
                  	Action []string
                  
                  	// An error.
                  	Error *string
                  
                  	// Indicates whether the policy that generated the finding allows public access to
                  	// the resource.
                  	IsPublic *bool
                  
                  	// The external principal that access to a resource within the zone of trust.
                  	Principal map[string]string
                  
                  	// The resource that an external principal has access to.
                  	Resource *string
                  
                  	// The sources of the finding. This indicates how the access that generated the
                  	// finding is granted. It is populated for Amazon S3 bucket findings.
                  	Sources []FindingSource
                  }

                    Contains information about a finding.

                    type FindingSource

                    type FindingSource struct {
                    
                    	// Indicates the type of access that generated the finding.
                    	//
                    	// This member is required.
                    	Type FindingSourceType
                    
                    	// Includes details about how the access that generated the finding is granted.
                    	// This is populated for Amazon S3 bucket findings.
                    	Detail *FindingSourceDetail
                    }

                      The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

                      type FindingSourceDetail

                      type FindingSourceDetail struct {
                      
                      	// The ARN of the access point that generated the finding.
                      	AccessPointArn *string
                      }

                        Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

                        type FindingSourceType

                        type FindingSourceType string

                        func (FindingSourceType) Values

                          Values returns all known values for FindingSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                          type FindingStatus

                          type FindingStatus string

                          func (FindingStatus) Values

                          func (FindingStatus) Values() []FindingStatus

                            Values returns all known values for FindingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                            type FindingStatusUpdate

                            type FindingStatusUpdate string

                            func (FindingStatusUpdate) Values

                              Values returns all known values for FindingStatusUpdate. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                              type FindingSummary

                              type FindingSummary struct {
                              
                              	// The time at which the resource-based policy that generated the finding was
                              	// analyzed.
                              	//
                              	// This member is required.
                              	AnalyzedAt *time.Time
                              
                              	// The condition in the analyzed policy statement that resulted in a finding.
                              	//
                              	// This member is required.
                              	Condition map[string]string
                              
                              	// The time at which the finding was created.
                              	//
                              	// This member is required.
                              	CreatedAt *time.Time
                              
                              	// The ID of the finding.
                              	//
                              	// This member is required.
                              	Id *string
                              
                              	// The AWS account ID that owns the resource.
                              	//
                              	// This member is required.
                              	ResourceOwnerAccount *string
                              
                              	// The type of the resource that the external principal has access to.
                              	//
                              	// This member is required.
                              	ResourceType ResourceType
                              
                              	// The status of the finding.
                              	//
                              	// This member is required.
                              	Status FindingStatus
                              
                              	// The time at which the finding was most recently updated.
                              	//
                              	// This member is required.
                              	UpdatedAt *time.Time
                              
                              	// The action in the analyzed policy statement that an external principal has
                              	// permission to use.
                              	Action []string
                              
                              	// The error that resulted in an Error finding.
                              	Error *string
                              
                              	// Indicates whether the finding reports a resource that has a policy that allows
                              	// public access.
                              	IsPublic *bool
                              
                              	// The external principal that has access to a resource within the zone of trust.
                              	Principal map[string]string
                              
                              	// The resource that the external principal has access to.
                              	Resource *string
                              
                              	// The sources of the finding. This indicates how the access that generated the
                              	// finding is granted. It is populated for Amazon S3 bucket findings.
                              	Sources []FindingSource
                              }

                                Contains information about a finding.

                                type InlineArchiveRule

                                type InlineArchiveRule struct {
                                
                                	// The condition and values for a criterion.
                                	//
                                	// This member is required.
                                	Filter map[string]Criterion
                                
                                	// The name of the rule.
                                	//
                                	// This member is required.
                                	RuleName *string
                                }

                                  An criterion statement in an archive rule. Each archive rule may have multiple criteria.

                                  type InternalServerException

                                  type InternalServerException struct {
                                  	Message *string
                                  
                                  	RetryAfterSeconds *int32
                                  }

                                    Internal server error.

                                    func (*InternalServerException) Error

                                    func (e *InternalServerException) Error() string

                                    func (*InternalServerException) ErrorCode

                                    func (e *InternalServerException) ErrorCode() string

                                    func (*InternalServerException) ErrorFault

                                    func (e *InternalServerException) ErrorFault() smithy.ErrorFault

                                    func (*InternalServerException) ErrorMessage

                                    func (e *InternalServerException) ErrorMessage() string

                                    type OrderBy

                                    type OrderBy string

                                    func (OrderBy) Values

                                    func (OrderBy) Values() []OrderBy

                                      Values returns all known values for OrderBy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                      type ReasonCode

                                      type ReasonCode string

                                      func (ReasonCode) Values

                                      func (ReasonCode) Values() []ReasonCode

                                        Values returns all known values for ReasonCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                        type ResourceNotFoundException

                                        type ResourceNotFoundException struct {
                                        	Message *string
                                        
                                        	ResourceId   *string
                                        	ResourceType *string
                                        }

                                          The specified resource could not be found.

                                          func (*ResourceNotFoundException) Error

                                          func (e *ResourceNotFoundException) Error() string

                                          func (*ResourceNotFoundException) ErrorCode

                                          func (e *ResourceNotFoundException) ErrorCode() string

                                          func (*ResourceNotFoundException) ErrorFault

                                          func (*ResourceNotFoundException) ErrorMessage

                                          func (e *ResourceNotFoundException) ErrorMessage() string

                                          type ResourceType

                                          type ResourceType string

                                          func (ResourceType) Values

                                          func (ResourceType) Values() []ResourceType

                                            Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                            type ServiceQuotaExceededException

                                            type ServiceQuotaExceededException struct {
                                            	Message *string
                                            
                                            	ResourceId   *string
                                            	ResourceType *string
                                            }

                                              Service quote met error.

                                              func (*ServiceQuotaExceededException) Error

                                              func (*ServiceQuotaExceededException) ErrorCode

                                              func (e *ServiceQuotaExceededException) ErrorCode() string

                                              func (*ServiceQuotaExceededException) ErrorFault

                                              func (*ServiceQuotaExceededException) ErrorMessage

                                              func (e *ServiceQuotaExceededException) ErrorMessage() string

                                              type SortCriteria

                                              type SortCriteria struct {
                                              
                                              	// The name of the attribute to sort on.
                                              	AttributeName *string
                                              
                                              	// The sort order, ascending or descending.
                                              	OrderBy OrderBy
                                              }

                                                The criteria used to sort.

                                                type StatusReason

                                                type StatusReason struct {
                                                
                                                	// The reason code for the current status of the analyzer.
                                                	//
                                                	// This member is required.
                                                	Code ReasonCode
                                                }

                                                  Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.

                                                  type ThrottlingException

                                                  type ThrottlingException struct {
                                                  	Message *string
                                                  
                                                  	RetryAfterSeconds *int32
                                                  }

                                                    Throttling limit exceeded error.

                                                    func (*ThrottlingException) Error

                                                    func (e *ThrottlingException) Error() string

                                                    func (*ThrottlingException) ErrorCode

                                                    func (e *ThrottlingException) ErrorCode() string

                                                    func (*ThrottlingException) ErrorFault

                                                    func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

                                                    func (*ThrottlingException) ErrorMessage

                                                    func (e *ThrottlingException) ErrorMessage() string

                                                    type Type

                                                    type Type string

                                                    func (Type) Values

                                                    func (Type) Values() []Type

                                                      Values returns all known values for Type. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                      type ValidationException

                                                      type ValidationException struct {
                                                      	Message *string
                                                      
                                                      	Reason    ValidationExceptionReason
                                                      	FieldList []ValidationExceptionField
                                                      }

                                                        Validation exception error.

                                                        func (*ValidationException) Error

                                                        func (e *ValidationException) Error() string

                                                        func (*ValidationException) ErrorCode

                                                        func (e *ValidationException) ErrorCode() string

                                                        func (*ValidationException) ErrorFault

                                                        func (e *ValidationException) ErrorFault() smithy.ErrorFault

                                                        func (*ValidationException) ErrorMessage

                                                        func (e *ValidationException) ErrorMessage() string

                                                        type ValidationExceptionField

                                                        type ValidationExceptionField struct {
                                                        
                                                        	// A message about the validation exception.
                                                        	//
                                                        	// This member is required.
                                                        	Message *string
                                                        
                                                        	// The name of the validation exception.
                                                        	//
                                                        	// This member is required.
                                                        	Name *string
                                                        }

                                                          Contains information about a validation exception.

                                                          type ValidationExceptionReason

                                                          type ValidationExceptionReason string
                                                          const (
                                                          	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
                                                          	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
                                                          	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
                                                          	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
                                                          )

                                                            Enum values for ValidationExceptionReason

                                                            func (ValidationExceptionReason) Values

                                                              Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.