Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessControlAttribute

type AccessControlAttribute struct {

	// The name of the attribute associated with your identities in your identity
	// source. This is used to map a specified attribute in your identity source with
	// an attribute in AWS SSO.
	//
	// This member is required.
	Key *string

	// The value used for mapping a specified attribute to an identity source.
	//
	// This member is required.
	Value *AccessControlAttributeValue
}

    These are AWS SSO identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permission policies that determine who can access your AWS resources based upon the configured attribute value(s). When you enable ABAC and specify AccessControlAttributes, AWS SSO passes the attribute(s) value of the authenticated user into IAM for use in policy evaluation.

    type AccessControlAttributeValue

    type AccessControlAttributeValue struct {
    
    	// The identity source to use when mapping a specified attribute to AWS SSO.
    	//
    	// This member is required.
    	Source []string
    }

      The value used for mapping a specified attribute to an identity source.

      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 AccountAssignment

        type AccountAssignment struct {
        
        	// The identifier of the AWS account.
        	AccountId *string
        
        	// The ARN of the permission set. For more information about ARNs, see Amazon
        	// Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
        	PermissionSetArn *string
        
        	// An identifier for an object in AWS SSO, such as a user or group. PrincipalIds
        	// are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
        	// information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API
        	// Reference.
        	PrincipalId *string
        
        	// The entity type for which the assignment will be created.
        	PrincipalType PrincipalType
        }

          The assignment that indicates a principal's limited access to a specified AWS account with a specified permission set. The term principal here refers to a user or group that is defined in AWS SSO.

          type AccountAssignmentOperationStatus

          type AccountAssignmentOperationStatus struct {
          
          	// The date that the permission set was created.
          	CreatedDate *time.Time
          
          	// The message that contains an error or exception in case of an operation failure.
          	FailureReason *string
          
          	// The ARN of the permission set. For more information about ARNs, see Amazon
          	// Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
          	PermissionSetArn *string
          
          	// An identifier for an object in AWS SSO, such as a user or group. PrincipalIds
          	// are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more
          	// information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API
          	// Reference.
          	PrincipalId *string
          
          	// The entity type for which the assignment will be created.
          	PrincipalType PrincipalType
          
          	// The identifier for tracking the request operation that is generated by the
          	// universally unique identifier (UUID) workflow.
          	RequestId *string
          
          	// The status of the permission set provisioning process.
          	Status StatusValues
          
          	// TargetID is an AWS account identifier, typically a 10-12 digit string (For
          	// example, 123456789012).
          	TargetId *string
          
          	// The entity type for which the assignment will be created.
          	TargetType TargetType
          }

            The status of the creation or deletion operation of an assignment that a principal needs to access an account.

            type AccountAssignmentOperationStatusMetadata

            type AccountAssignmentOperationStatusMetadata struct {
            
            	// The date that the permission set was created.
            	CreatedDate *time.Time
            
            	// The identifier for tracking the request operation that is generated by the
            	// universally unique identifier (UUID) workflow.
            	RequestId *string
            
            	// The status of the permission set provisioning process.
            	Status StatusValues
            }

              Provides information about the AccountAssignment creation request.

              type AttachedManagedPolicy

              type AttachedManagedPolicy struct {
              
              	// The ARN of the IAM managed policy. For more information about ARNs, see Amazon
              	// Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
              	Arn *string
              
              	// The name of the IAM managed policy.
              	Name *string
              }

                A structure that stores the details of the IAM managed policy.

                type ConflictException

                type ConflictException struct {
                	Message *string
                }

                  Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

                  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 InstanceAccessControlAttributeConfiguration

                  type InstanceAccessControlAttributeConfiguration struct {
                  
                  	// Lists the attributes that are configured for ABAC in the specified AWS SSO
                  	// instance.
                  	//
                  	// This member is required.
                  	AccessControlAttributes []AccessControlAttribute
                  }

                    Specifies the attributes to add to your attribute-based access control (ABAC) configuration.

                    type InstanceAccessControlAttributeConfigurationStatus

                    type InstanceAccessControlAttributeConfigurationStatus string
                    const (
                    	InstanceAccessControlAttributeConfigurationStatusEnabled            InstanceAccessControlAttributeConfigurationStatus = "ENABLED"
                    	InstanceAccessControlAttributeConfigurationStatusCreationInProgress InstanceAccessControlAttributeConfigurationStatus = "CREATION_IN_PROGRESS"
                    	InstanceAccessControlAttributeConfigurationStatusCreationFailed     InstanceAccessControlAttributeConfigurationStatus = "CREATION_FAILED"
                    )

                      Enum values for InstanceAccessControlAttributeConfigurationStatus

                      func (InstanceAccessControlAttributeConfigurationStatus) Values

                        Values returns all known values for InstanceAccessControlAttributeConfigurationStatus. 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 InstanceMetadata

                        type InstanceMetadata struct {
                        
                        	// The identifier of the identity store that is connected to the SSO instance.
                        	IdentityStoreId *string
                        
                        	// The ARN of the SSO instance under which the operation will be executed. For more
                        	// information about ARNs, see Amazon Resource Names (ARNs) and AWS Service
                        	// Namespaces in the AWS General Reference.
                        	InstanceArn *string
                        }

                          Provides information about the SSO instance.

                          type InternalServerException

                          type InternalServerException struct {
                          	Message *string
                          }

                            The request processing has failed because of an unknown error, exception, or failure with an internal server.

                            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 OperationStatusFilter

                            type OperationStatusFilter struct {
                            
                            	// Filters the list operations result based on the status attribute.
                            	Status StatusValues
                            }

                              Filters he operation status list based on the passed attribute value.

                              type PermissionSet

                              type PermissionSet struct {
                              
                              	// The date that the permission set was created.
                              	CreatedDate *time.Time
                              
                              	// The description of the PermissionSet.
                              	Description *string
                              
                              	// The name of the permission set.
                              	Name *string
                              
                              	// The ARN of the permission set. For more information about ARNs, see Amazon
                              	// Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
                              	PermissionSetArn *string
                              
                              	// Used to redirect users within the application during the federation
                              	// authentication process.
                              	RelayState *string
                              
                              	// The length of time that the application user sessions are valid for in the
                              	// ISO-8601 standard.
                              	SessionDuration *string
                              }

                                An entity that contains IAM policies.

                                type PermissionSetProvisioningStatus

                                type PermissionSetProvisioningStatus struct {
                                
                                	// The identifier of the AWS account from which to list the assignments.
                                	AccountId *string
                                
                                	// The date that the permission set was created.
                                	CreatedDate *time.Time
                                
                                	// The message that contains an error or exception in case of an operation failure.
                                	FailureReason *string
                                
                                	// The ARN of the permission set that is being provisioned. For more information
                                	// about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the
                                	// AWS General Reference.
                                	PermissionSetArn *string
                                
                                	// The identifier for tracking the request operation that is generated by the
                                	// universally unique identifier (UUID) workflow.
                                	RequestId *string
                                
                                	// The status of the permission set provisioning process.
                                	Status StatusValues
                                }

                                  A structure that is used to provide the status of the provisioning operation for a specified permission set.

                                  type PermissionSetProvisioningStatusMetadata

                                  type PermissionSetProvisioningStatusMetadata struct {
                                  
                                  	// The date that the permission set was created.
                                  	CreatedDate *time.Time
                                  
                                  	// The identifier for tracking the request operation that is generated by the
                                  	// universally unique identifier (UUID) workflow.
                                  	RequestId *string
                                  
                                  	// The status of the permission set provisioning process.
                                  	Status StatusValues
                                  }

                                    Provides information about the permission set provisioning status.

                                    type PrincipalType

                                    type PrincipalType string
                                    const (
                                    	PrincipalTypeUser  PrincipalType = "USER"
                                    	PrincipalTypeGroup PrincipalType = "GROUP"
                                    )

                                      Enum values for PrincipalType

                                      func (PrincipalType) Values

                                      func (PrincipalType) Values() []PrincipalType

                                        Values returns all known values for PrincipalType. 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 ProvisionTargetType

                                        type ProvisionTargetType string
                                        const (
                                        	ProvisionTargetTypeAwsAccount             ProvisionTargetType = "AWS_ACCOUNT"
                                        	ProvisionTargetTypeAllProvisionedAccounts ProvisionTargetType = "ALL_PROVISIONED_ACCOUNTS"
                                        )

                                          Enum values for ProvisionTargetType

                                          func (ProvisionTargetType) Values

                                            Values returns all known values for ProvisionTargetType. 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 ProvisioningStatus

                                            type ProvisioningStatus string
                                            const (
                                            	ProvisioningStatusLatestPermissionSetProvisioned    ProvisioningStatus = "LATEST_PERMISSION_SET_PROVISIONED"
                                            	ProvisioningStatusLatestPermissionSetNotProvisioned ProvisioningStatus = "LATEST_PERMISSION_SET_NOT_PROVISIONED"
                                            )

                                              Enum values for ProvisioningStatus

                                              func (ProvisioningStatus) Values

                                                Values returns all known values for ProvisioningStatus. 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
                                                }

                                                  Indicates that a requested resource is not 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 ServiceQuotaExceededException

                                                  type ServiceQuotaExceededException struct {
                                                  	Message *string
                                                  }

                                                    Indicates that the principal has crossed the permitted number of resources that can be created.

                                                    func (*ServiceQuotaExceededException) Error

                                                    func (*ServiceQuotaExceededException) ErrorCode

                                                    func (e *ServiceQuotaExceededException) ErrorCode() string

                                                    func (*ServiceQuotaExceededException) ErrorFault

                                                    func (*ServiceQuotaExceededException) ErrorMessage

                                                    func (e *ServiceQuotaExceededException) ErrorMessage() string

                                                    type StatusValues

                                                    type StatusValues string
                                                    const (
                                                    	StatusValuesInProgress StatusValues = "IN_PROGRESS"
                                                    	StatusValuesFailed     StatusValues = "FAILED"
                                                    	StatusValuesSucceeded  StatusValues = "SUCCEEDED"
                                                    )

                                                      Enum values for StatusValues

                                                      func (StatusValues) Values

                                                      func (StatusValues) Values() []StatusValues

                                                        Values returns all known values for StatusValues. 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 Tag

                                                        type Tag struct {
                                                        
                                                        	// The key for the tag.
                                                        	Key *string
                                                        
                                                        	// The value of the tag.
                                                        	Value *string
                                                        }

                                                          A set of key-value pairs that are used to manage the resource. Tags can only be applied to permission sets and cannot be applied to corresponding roles that AWS SSO creates in AWS accounts.

                                                          type TargetType

                                                          type TargetType string
                                                          const (
                                                          	TargetTypeAwsAccount TargetType = "AWS_ACCOUNT"
                                                          )

                                                            Enum values for TargetType

                                                            func (TargetType) Values

                                                            func (TargetType) Values() []TargetType

                                                              Values returns all known values for TargetType. 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 ThrottlingException

                                                              type ThrottlingException struct {
                                                              	Message *string
                                                              }

                                                                Indicates that the principal has crossed the throttling limits of the API operations.

                                                                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 ValidationException

                                                                type ValidationException struct {
                                                                	Message *string
                                                                }

                                                                  The request failed because it contains a syntax 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