Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: iam x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iam-2010-05-08.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/iam/ servers: - url: https://iam.amazonaws.com variables: {} description: The general IAM multi-region endpoint - url: http://iam.us-gov.amazonaws.com variables: {} description: The general IAM endpoint for AWS GovCloud (US) and AWS GovCloud (US-East) - url: https://iam.us-gov.amazonaws.com variables: {} description: The general IAM endpoint for AWS GovCloud (US) and AWS GovCloud (US-East) - url: http://iam.cn-north-1.amazonaws.com.cn variables: {} description: The general IAM endpoint for China (Beijing) and China (Ningxia) - url: https://iam.cn-north-1.amazonaws.com.cn variables: {} description: The general IAM endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#Action=AddClientIDToOpenIDConnectProvider: get: x-aws-operation-name: AddClientIDToOpenIDConnectProvider operationId: GET_AddClientIDToOpenIDConnectProvider description:Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: OpenIDConnectProviderArn in: query required: true description: The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation. schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: ClientID in: query required: true description: The client ID (also known as audience) to add to the IAM OpenID Connect provider resource. schema: type: string minLength: 1 maxLength: 255 - name: Action in: query required: true schema: type: string enum: - AddClientIDToOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AddClientIDToOpenIDConnectProvider operationId: POST_AddClientIDToOpenIDConnectProvider description:Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AddClientIDToOpenIDConnectProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AddClientIDToOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=AddRoleToInstanceProfile: get: x-aws-operation-name: AddRoleToInstanceProfile operationId: GET_AddRoleToInstanceProfile description:Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.
The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.
For more information about roles, see Working with roles. For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: RoleName in: query required: true description: 'The name of the role to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - AddRoleToInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AddRoleToInstanceProfile operationId: POST_AddRoleToInstanceProfile description:Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.
The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.
For more information about roles, see Working with roles. For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AddRoleToInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AddRoleToInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=AddUserToGroup: get: x-aws-operation-name: AddUserToGroup operationId: GET_AddUserToGroup description: Adds the specified user to the specified group. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: UserName in: query required: true description: 'The name of the user to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - AddUserToGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AddUserToGroup operationId: POST_AddUserToGroup description: Adds the specified user to the specified group. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AddUserToGroupRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AddUserToGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=AttachGroupPolicy: get: x-aws-operation-name: AttachGroupPolicy operationId: GET_AttachGroupPolicy description:Attaches the specified managed policy to the specified IAM group.
You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name (friendly name, not ARN) of the group to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - AttachGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachGroupPolicy operationId: POST_AttachGroupPolicy description:Attaches the specified managed policy to the specified IAM group.
You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachGroupPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AttachGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=AttachRolePolicy: get: x-aws-operation-name: AttachRolePolicy operationId: GET_AttachRolePolicy description:Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.
You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name (friendly name, not ARN) of the role to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - AttachRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachRolePolicy operationId: POST_AttachRolePolicy description:Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.
You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.
Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachRolePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AttachRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=AttachUserPolicy: get: x-aws-operation-name: AttachUserPolicy operationId: GET_AttachUserPolicy description:Attaches the specified managed policy to the specified user.
You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name (friendly name, not ARN) of the IAM user to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - AttachUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachUserPolicy operationId: POST_AttachUserPolicy description:Attaches the specified managed policy to the specified user.
You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: PolicyNotAttachableException content: text/xml: schema: $ref: "#/components/schemas/PolicyNotAttachableException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachUserPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - AttachUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ChangePassword: get: x-aws-operation-name: ChangePassword operationId: GET_ChangePassword description:Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.
Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidUserTypeException content: text/xml: schema: $ref: "#/components/schemas/InvalidUserTypeException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "484": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: OldPassword in: query required: true description: The IAM user's current password. schema: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 128 format: password - name: NewPassword in: query required: true description:The new password. The new password must conform to the Amazon Web Services account's password policy, if one exists.
The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.
Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.
Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidUserTypeException content: text/xml: schema: $ref: "#/components/schemas/InvalidUserTypeException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "484": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ChangePasswordRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ChangePassword - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateAccessKey: get: x-aws-operation-name: CreateAccessKey operationId: GET_CreateAccessKey description: Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
The name of the IAM user that the new key will belong to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - CreateAccessKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateAccessKey operationId: POST_CreateAccessKey description: Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
The account alias to create.
This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
schema: type: string pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ minLength: 3 maxLength: 63 - name: Action in: query required: true schema: type: string enum: - CreateAccountAlias - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateAccountAlias operationId: POST_CreateAccountAlias description: Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide. responses: "200": description: Success "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateAccountAliasRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateAccountAlias - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateGroup: get: x-aws-operation-name: CreateGroup operationId: GET_CreateGroup description:Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateGroupResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Path in: query required: false description:The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the group to create. Do not include the path in this value.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - CreateGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateGroup operationId: POST_CreateGroup description:Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateGroupResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateGroupRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateInstanceProfile: get: x-aws-operation-name: CreateInstanceProfile operationId: GET_CreateInstanceProfile description:Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateInstanceProfileResponse" "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to create.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Path in: query required: false description:The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateInstanceProfileResponse" "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateLoginProfile: get: x-aws-operation-name: CreateLoginProfile operationId: GET_CreateLoginProfile description:Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about managing passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateLoginProfileResponse" "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user to create a password for. The user must already exist.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Password in: query required: true description:The new password for the user.
The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.
Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about managing passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateLoginProfileResponse" "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateLoginProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateLoginProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateOpenIDConnectProvider: get: x-aws-operation-name: CreateOpenIDConnectProvider operationId: GET_CreateOpenIDConnectProvider description:Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.
You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.
schema: type: string description: Contains a URL that specifies the endpoint for an OpenID Connect provider. minLength: 1 maxLength: 255 - name: ClientIDList in: query required: false description:Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that's sent as the client_id parameter on OAuth requests.
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.
schema: type: array description: Contains a list of thumbprints of identity provider server certificates. items: $ref: "#/components/schemas/thumbprintType" - name: Tags in: query required: false description:A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
Creates a new managed policy for your Amazon Web Services account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "483": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "484": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyName in: query required: true description:The friendly name of the policy.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Path in: query required: false description:The path for the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
You cannot use an asterisk (*) in the path name.
The JSON policy document that you want to use as the content for the new policy.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
A friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
schema: type: string maxLength: 1000 - name: Tags in: query required: false description:A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates a new managed policy for your Amazon Web Services account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "483": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "484": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreatePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreatePolicyVersion: get: x-aws-operation-name: CreatePolicyVersion operationId: GET_CreatePolicyVersion description:Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyVersionResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: PolicyDocument in: query required: true description:The JSON policy document that you want to use as the content for this new version of the policy.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
schema: type: boolean - name: Action in: query required: true schema: type: string enum: - CreatePolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreatePolicyVersion operationId: POST_CreatePolicyVersion description:Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyVersionResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreatePolicyVersionRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreatePolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateRole: get: x-aws-operation-name: CreateRole operationId: GET_CreateRole description: Creates a new role for your Amazon Web Services account. For more information about roles, see IAM roles. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateRoleResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "483": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "484": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Path in: query required: false description:The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: AssumeRolePolicyDocument in: query required: true description:The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Upon success, the response includes the same trust policy in JSON format.
schema: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 131072 - name: Description in: query required: false description: A description of the role. schema: type: string pattern: "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" maxLength: 1000 - name: MaxSessionDuration in: query required: false description:The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Tags in: query required: false description:A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.
When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateSAMLProviderResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: SAMLMetadataDocument in: query required: true description:An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see About SAML 2.0-based federation in the IAM User Guide
schema: type: string minLength: 1000 maxLength: 10000000 - name: Name in: query required: true description: 'The name of the provider to create.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w._-]+" minLength: 1 maxLength: 128 - name: Tags in: query required: false description:A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.
When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateSAMLProviderResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateSAMLProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateServiceLinkedRole: get: x-aws-operation-name: CreateServiceLinkedRole operationId: GET_CreateServiceLinkedRole description:Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateServiceLinkedRoleResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: AWSServiceName in: query required: true description: 'The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Description in: query required: false description: The description of the role. schema: type: string pattern: "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" maxLength: 1000 - name: CustomSuffix in: query required: false description:A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.
Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.
Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateServiceLinkedRoleResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateServiceLinkedRoleRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateServiceLinkedRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateServiceSpecificCredential: get: x-aws-operation-name: CreateServiceSpecificCredential operationId: GET_CreateServiceSpecificCredential description: 'Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.
You can have a maximum of two sets of service-specific credentials for each supported service per user.
You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateServiceSpecificCredentialResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceNotSupportedException content: text/xml: schema: $ref: "#/components/schemas/ServiceNotSupportedException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: ServiceName in: query required: true description: The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials. schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateServiceSpecificCredential operationId: POST_CreateServiceSpecificCredential description: 'Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.
You can have a maximum of two sets of service-specific credentials for each supported service per user.
You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateServiceSpecificCredentialResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceNotSupportedException content: text/xml: schema: $ref: "#/components/schemas/ServiceNotSupportedException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateServiceSpecificCredentialRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateUser: get: x-aws-operation-name: CreateUser operationId: GET_CreateUser description:Creates a new IAM user for your Amazon Web Services account.
For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateUserResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "484": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Path in: query required: false description:The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the user to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PermissionsBoundary in: query required: false description:The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Tags in: query required: false description:A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates a new IAM user for your Amazon Web Services account.
For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CreateUserResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "482": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "483": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "484": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateUserRequest" parameters: - name: Action in: query required: true schema: type: string enum: - CreateUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=CreateVirtualMFADevice: get: x-aws-operation-name: CreateVirtualMFADevice operationId: GET_CreateVirtualMFADevice description:Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 - name: Tags in: query required: false description:A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.
responses: "200": description: Success "480": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the user whose MFA device you want to deactivate.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: SerialNumber in: query required: true description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: Action in: query required: true schema: type: string enum: - DeactivateMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeactivateMFADevice operationId: POST_DeactivateMFADevice description:Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.
responses: "200": description: Success "480": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeactivateMFADeviceRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeactivateMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteAccessKey: get: x-aws-operation-name: DeleteAccessKey operationId: GET_DeleteAccessKey description:Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: false description: 'The name of the user whose access key pair you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: AccessKeyId in: query required: true description:The access key ID for the access key ID and secret access key you want to delete.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 16 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteAccessKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteAccessKey operationId: POST_DeleteAccessKey description:Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteAccessKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteAccessKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteAccountAlias: get: x-aws-operation-name: DeleteAccountAlias operationId: GET_DeleteAccountAlias description: ' Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide.' responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: AccountAlias in: query required: true description:The name of the account alias to delete.
This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
schema: type: string pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ minLength: 3 maxLength: 63 - name: Action in: query required: true schema: type: string enum: - DeleteAccountAlias - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteAccountAlias operationId: POST_DeleteAccountAlias description: ' Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Using an alias for your Amazon Web Services account ID in the IAM User Guide.' responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteAccountAliasRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteAccountAlias - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteAccountPasswordPolicy: get: x-aws-operation-name: DeleteAccountPasswordPolicy operationId: GET_DeleteAccountPasswordPolicy description: Deletes the password policy for the Amazon Web Services account. There are no parameters. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteAccountPasswordPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteAccountPasswordPolicy operationId: POST_DeleteAccountPasswordPolicy description: Deletes the password policy for the Amazon Web Services account. There are no parameters. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteAccountPasswordPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteGroup: get: x-aws-operation-name: DeleteGroup operationId: GET_DeleteGroup description: Deletes the specified IAM group. The group must not contain any users or have any attached policies. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name of the IAM group to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteGroup operationId: POST_DeleteGroup description: Deletes the specified IAM group. The group must not contain any users or have any attached policies. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteGroupRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteGroupPolicy: get: x-aws-operation-name: DeleteGroupPolicy operationId: GET_DeleteGroupPolicy description:Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name (friendly name, not ARN) identifying the group that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name identifying the policy document to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteGroupPolicy operationId: POST_DeleteGroupPolicy description:Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteGroupPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteInstanceProfile: get: x-aws-operation-name: DeleteInstanceProfile operationId: GET_DeleteInstanceProfile description:Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteInstanceProfile operationId: POST_DeleteInstanceProfile description:Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteLoginProfile: get: x-aws-operation-name: DeleteLoginProfile operationId: GET_DeleteLoginProfile description:Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
The name of the user whose password you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - DeleteLoginProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteLoginProfile operationId: POST_DeleteLoginProfile description:Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: OpenIDConnectProviderArn in: query required: true description: The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation. schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DeleteOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteOpenIDConnectProvider operationId: POST_DeleteOpenIDConnectProvider description:Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteOpenIDConnectProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeletePolicy: get: x-aws-operation-name: DeletePolicy operationId: GET_DeletePolicy description:Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:
Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
Delete the policy (this automatically deletes the policy's default version) using this operation.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to delete.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DeletePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeletePolicy operationId: POST_DeletePolicy description:Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:
Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
Delete the policy (this automatically deletes the policy's default version) using this operation.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeletePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeletePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeletePolicyVersion: get: x-aws-operation-name: DeletePolicyVersion operationId: GET_DeletePolicyVersion description:Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: VersionId in: query required: true description:The policy version to delete.
This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
schema: type: string pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - name: Action in: query required: true schema: type: string enum: - DeletePolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeletePolicyVersion operationId: POST_DeletePolicyVersion description:Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: DeleteConflictException content: text/xml: schema: $ref: "#/components/schemas/DeleteConflictException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeletePolicyVersionRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeletePolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteRole: get: x-aws-operation-name: DeleteRole operationId: GET_DeleteRole description: 'Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy)
Instance profile (RemoveRoleFromInstanceProfile)
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
The name of the role to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - DeleteRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteRole operationId: POST_DeleteRole description: 'Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy)
Instance profile (RemoveRoleFromInstanceProfile)
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
Deletes the permissions boundary for the specified IAM role.
You cannot set the boundary for a service-linked role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
Deletes the permissions boundary for the specified IAM role.
You cannot set the boundary for a service-linked role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name (friendly name, not ARN) identifying the role that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyName in: query required: true description: 'The name of the inline policy to delete from the specified IAM role.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteRolePolicy operationId: POST_DeleteRolePolicy description:Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteRolePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteSAMLProvider: get: x-aws-operation-name: DeleteSAMLProvider operationId: GET_DeleteSAMLProvider description:Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DeleteSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteSAMLProvider operationId: POST_DeleteSAMLProvider description:Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
Deletes the specified SSH public key.
The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: SSHPublicKeyId in: query required: true description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteSSHPublicKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteSSHPublicKey operationId: POST_DeleteSSHPublicKey description:Deletes the specified SSH public key.
The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteSSHPublicKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteSSHPublicKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteServerCertificate: get: x-aws-operation-name: DeleteServerCertificate operationId: GET_DeleteServerCertificate description:Deletes the specified server certificate.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
The name of the server certificate you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteServerCertificate operationId: POST_DeleteServerCertificate description:Deletes the specified server certificate.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.
Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.
If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentation for your service.
For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteServiceLinkedRoleResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: The name of the service-linked role to be deleted. schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - DeleteServiceLinkedRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteServiceLinkedRole operationId: POST_DeleteServiceLinkedRole description: 'Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.
If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentation for your service.
For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteServiceLinkedRoleResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteServiceLinkedRoleRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteServiceLinkedRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteServiceSpecificCredential: get: x-aws-operation-name: DeleteServiceSpecificCredential operationId: GET_DeleteServiceSpecificCredential description: Deletes the specified service-specific credential. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: UserName in: query required: false description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: ServiceSpecificCredentialId in: query required: true description:The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteServiceSpecificCredential operationId: POST_DeleteServiceSpecificCredential description: Deletes the specified service-specific credential. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteServiceSpecificCredentialRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteSigningCertificate: get: x-aws-operation-name: DeleteSigningCertificate operationId: GET_DeleteSigningCertificate description:Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: false description: 'The name of the user the signing certificate belongs to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: CertificateId in: query required: true description:The ID of the signing certificate to delete.
The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.
schema: type: string pattern: "[\\w]+" minLength: 24 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteSigningCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteSigningCertificate operationId: POST_DeleteSigningCertificate description:Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteSigningCertificateRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteSigningCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteUser: get: x-aws-operation-name: DeleteUser operationId: GET_DeleteUser description:Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
Git credentials (DeleteServiceSpecificCredential)
Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
The name of the user to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteUser operationId: POST_DeleteUser description:Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user. Before attempting to delete a user, remove the following items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
Git credentials (DeleteServiceSpecificCredential)
Multi-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
Deletes the permissions boundary for the specified IAM user.
Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.
Deletes the permissions boundary for the specified IAM user.
Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.
Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name (friendly name, not ARN) identifying the user that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name identifying the policy document to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - DeleteUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteUserPolicy operationId: POST_DeleteUserPolicy description:Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteUserPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DeleteVirtualMFADevice: get: x-aws-operation-name: DeleteVirtualMFADevice operationId: GET_DeleteVirtualMFADevice description:Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: Action in: query required: true schema: type: string enum: - DeleteVirtualMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteVirtualMFADevice operationId: POST_DeleteVirtualMFADevice description:Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name (friendly name, not ARN) of the IAM group to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DetachGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DetachGroupPolicy operationId: POST_DetachGroupPolicy description:Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DetachGroupPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DetachGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DetachRolePolicy: get: x-aws-operation-name: DetachRolePolicy operationId: GET_DetachRolePolicy description:Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name (friendly name, not ARN) of the IAM role to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DetachRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DetachRolePolicy operationId: POST_DetachRolePolicy description:Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DetachRolePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DetachRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=DetachUserPolicy: get: x-aws-operation-name: DetachUserPolicy operationId: GET_DetachUserPolicy description:Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name (friendly name, not ARN) of the IAM user to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - DetachUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DetachUserPolicy operationId: POST_DetachUserPolicy description:Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DetachUserPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DetachUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=EnableMFADevice: get: x-aws-operation-name: EnableMFADevice operationId: GET_EnableMFADevice description: Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device. responses: "200": description: Success "480": description: EntityAlreadyExistsException content: text/xml: schema: $ref: "#/components/schemas/EntityAlreadyExistsException" "481": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "482": description: InvalidAuthenticationCodeException content: text/xml: schema: $ref: "#/components/schemas/InvalidAuthenticationCodeException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "485": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user for whom you want to enable the MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: SerialNumber in: query required: true description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: AuthenticationCode1 in: query required: true description:An authentication code emitted by the device.
The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
A subsequent authentication code emitted by the device.
The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.
To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.
You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.
For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.
The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.
Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.
To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.
Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.
Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GenerateOrganizationsAccessReportResponse" "480": description: ReportGenerationLimitExceededException content: text/xml: schema: $ref: "#/components/schemas/ReportGenerationLimitExceededException" parameters: - name: EntityPath in: query required: true description: The path of the Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
schema:
type: string
pattern: ^o-[0-9a-z]{10,32}\/r-[0-9a-z]{4,32}[0-9a-z-\/]*
minLength: 19
maxLength: 427
- name: OrganizationsPolicyId
in: query
required: false
description: The identifier of the Organizations service control policy (SCP). This parameter is optional.
This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.
schema: type: string pattern: ^p-[0-9a-zA-Z_]{8,128}$ - name: Action in: query required: true schema: type: string enum: - GenerateOrganizationsAccessReport - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GenerateOrganizationsAccessReport operationId: POST_GenerateOrganizationsAccessReport description:Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.
To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.
You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.
For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed data in the IAM User Guide.
The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.
Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.
To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.
Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.
Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GenerateOrganizationsAccessReportResponse" "480": description: ReportGenerationLimitExceededException content: text/xml: schema: $ref: "#/components/schemas/ReportGenerationLimitExceededException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GenerateOrganizationsAccessReportRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GenerateOrganizationsAccessReport - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GenerateServiceLastAccessedDetails: get: x-aws-operation-name: GenerateServiceLastAccessedDetails operationId: GET_GenerateServiceLastAccessedDetails description: 'Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked.
The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GenerateServiceLastAccessedDetailsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: Arn in: query required: true description: The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service. schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Granularity in: query required: false description: The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don't include this optional parameter, the operation generates service data. schema: type: string enum: - SERVICE_LEVEL - ACTION_LEVEL - name: Action in: query required: true schema: type: string enum: - GenerateServiceLastAccessedDetails - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GenerateServiceLastAccessedDetails operationId: POST_GenerateServiceLastAccessedDetails description: 'Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked.
The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrail in the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GenerateServiceLastAccessedDetailsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GenerateServiceLastAccessedDetailsRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GenerateServiceLastAccessedDetails - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetAccessKeyLastUsed: get: x-aws-operation-name: GetAccessKeyLastUsed operationId: GET_GetAccessKeyLastUsed description: Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetAccessKeyLastUsedResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: AccessKeyId in: query required: true description:The identifier of an access key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 16 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetAccessKeyLastUsed - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetAccessKeyLastUsed operationId: POST_GetAccessKeyLastUsed description: Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetAccessKeyLastUsedResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetAccessKeyLastUsedRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetAccessKeyLastUsed - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetAccountAuthorizationDetails: get: x-aws-operation-name: GetAccountAuthorizationDetails operationId: GET_GetAccountAuthorizationDetails description:Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.
A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.
The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.
schema: type: array items: $ref: "#/components/schemas/EntityType" - name: MaxItems in: query required: false description:Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAccountAuthorizationDetails
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetAccountAuthorizationDetails
operationId: POST_GetAccountAuthorizationDetails
description: Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetAccountSummaryResponse" "480": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - GetAccountSummary - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetAccountSummary operationId: POST_GetAccountSummary description:Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetAccountSummaryResponse" "480": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - GetAccountSummary - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetContextKeysForCustomPolicy: get: x-aws-operation-name: GetContextKeysForCustomPolicy operationId: GET_GetContextKeysForCustomPolicy description:Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.
A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.
Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetContextKeysForPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: PolicySourceArn in: query required: true description:The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: PolicyInputList in: query required: false description:An optional list of additional policies for which you want the list of context keys that are referenced.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetContextKeysForPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetContextKeysForPrincipalPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetContextKeysForPrincipalPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetCredentialReport: get: x-aws-operation-name: GetCredentialReport operationId: GET_GetCredentialReport description: ' Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetCredentialReportResponse" "480": description: CredentialReportNotPresentException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportNotPresentException" "481": description: CredentialReportExpiredException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportExpiredException" "482": description: CredentialReportNotReadyException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportNotReadyException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - GetCredentialReport - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetCredentialReport operationId: POST_GetCredentialReport description: ' Retrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetCredentialReportResponse" "480": description: CredentialReportNotPresentException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportNotPresentException" "481": description: CredentialReportExpiredException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportExpiredException" "482": description: CredentialReportNotReadyException content: text/xml: schema: $ref: "#/components/schemas/CredentialReportNotReadyException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: Action in: query required: true schema: type: string enum: - GetCredentialReport - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetGroup: get: x-aws-operation-name: GetGroup operationId: GET_GetGroup description: " Returns a list of IAM users that are in the specified IAM group. You can paginate the results using theMaxItems and Marker parameters."
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/GetGroupResponse"
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
"481":
description: ServiceFailureException
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceFailureException"
parameters:
- name: GroupName
in: query
required: true
description: 'The name of the group.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
MaxItems and Marker parameters."
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/GetGroupResponse"
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
"481":
description: ServiceFailureException
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceFailureException"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/GetGroupRequest"
parameters:
- name: MaxItems
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
/#Action=GetGroupPolicy:
get:
x-aws-operation-name: GetGroupPolicy
operationId: GET_GetGroupPolicy
description: Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetGroupPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name of the group the policy is associated with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetGroupPolicy operationId: POST_GetGroupPolicy description:Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetGroupPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetGroupPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetGroupPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetInstanceProfile: get: x-aws-operation-name: GetInstanceProfile operationId: GET_GetInstanceProfile description: " Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About instance profiles in the IAM User Guide." responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetInstanceProfileResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to get information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetInstanceProfile operationId: POST_GetInstanceProfile description: " Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About instance profiles in the IAM User Guide." responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetInstanceProfileResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetLoginProfile: get: x-aws-operation-name: GetLoginProfile operationId: GET_GetLoginProfile description:Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.
The name of the user whose login profile you want to retrieve.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - GetLoginProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetLoginProfile operationId: POST_GetLoginProfile description:Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.
The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - GetOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetOpenIDConnectProvider operationId: POST_GetOpenIDConnectProvider description: Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetOpenIDConnectProviderResponse" "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetOpenIDConnectProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetOrganizationsAccessReport: get: x-aws-operation-name: GetOrganizationsAccessReport operationId: GET_GetOrganizationsAccessReport description:Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.
Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.
To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.
By default, the list is sorted by service namespace.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetOrganizationsAccessReportResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: JobId in: query required: true description: The identifier of the request generated by the GenerateOrganizationsAccessReport operation. schema: type: string minLength: 36 maxLength: 36 - name: MaxItems in: query required: false description:Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: SortKey
in: query
required: false
description: The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
schema:
type: string
enum:
- SERVICE_NAMESPACE_ASCENDING
- SERVICE_NAMESPACE_DESCENDING
- LAST_AUTHENTICATED_TIME_ASCENDING
- LAST_AUTHENTICATED_TIME_DESCENDING
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetOrganizationsAccessReport
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetOrganizationsAccessReport
operationId: POST_GetOrganizationsAccessReport
description: Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.
Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.
To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed data in the IAM User Guide.
For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.
By default, the list is sorted by service namespace.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetOrganizationsAccessReportResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetOrganizationsAccessReportRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetOrganizationsAccessReport - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetPolicy: get: x-aws-operation-name: GetPolicy operationId: GET_GetPolicy description:Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - GetPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetPolicy operationId: POST_GetPolicy description:Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetPolicyVersion: get: x-aws-operation-name: GetPolicyVersion operationId: GET_GetPolicyVersion description:Retrieves information about the specified version of the specified managed policy, including the policy document.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
To list the available versions for a policy, use ListPolicyVersions.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPolicyVersionResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: VersionId in: query required: true description:Identifies the policy version to retrieve.
This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
schema: type: string pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - name: Action in: query required: true schema: type: string enum: - GetPolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetPolicyVersion operationId: POST_GetPolicyVersion description:Retrieves information about the specified version of the specified managed policy, including the policy document.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
To list the available versions for a policy, use ListPolicyVersions.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPolicyVersionResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetPolicyVersionRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetPolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetRole: get: x-aws-operation-name: GetRole operationId: GET_GetRole description:Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with roles.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
The name of the IAM role to get information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - GetRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetRole operationId: POST_GetRole description:Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with roles.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
Retrieves the specified inline policy document that is embedded with the specified IAM role.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
For more information about roles, see Using roles to delegate permissions and federate identities.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetRolePolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name of the role associated with the policy.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyName in: query required: true description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetRolePolicy operationId: POST_GetRolePolicy description:Retrieves the specified inline policy document that is embedded with the specified IAM role.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
For more information about roles, see Using roles to delegate permissions and federate identities.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetRolePolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetRolePolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetRolePolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetSAMLProvider: get: x-aws-operation-name: GetSAMLProvider operationId: GET_GetSAMLProvider description:Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - GetSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetSAMLProvider operationId: POST_GetSAMLProvider description:Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetSSHPublicKeyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: UnrecognizedPublicKeyEncodingException content: text/xml: schema: $ref: "#/components/schemas/UnrecognizedPublicKeyEncodingException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: SSHPublicKeyId in: query required: true description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Encoding in: query required: true description: Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, useSSH. To retrieve the public key in PEM format, use PEM.
schema:
type: string
enum:
- SSH
- PEM
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSSHPublicKey
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetSSHPublicKey
operationId: POST_GetSSHPublicKey
description: Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetSSHPublicKeyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: UnrecognizedPublicKeyEncodingException content: text/xml: schema: $ref: "#/components/schemas/UnrecognizedPublicKeyEncodingException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetSSHPublicKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetSSHPublicKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetServerCertificate: get: x-aws-operation-name: GetServerCertificate operationId: GET_GetServerCertificate description:Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServerCertificateResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: ServerCertificateName in: query required: true description: 'The name of the server certificate you want to retrieve information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetServerCertificate operationId: POST_GetServerCertificate description:Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServerCertificateResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetServerCertificateRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetServiceLastAccessedDetails: get: x-aws-operation-name: GetServiceLastAccessedDetails operationId: GET_GetServiceLastAccessedDetails description:Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.
The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:
User – Returns the user ARN that you used to generate the report
Group – Returns the ARN of the group member (user) that last attempted to access the service
Role – Returns the role ARN that you used to generate the report
Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service
By default, the list is sorted by service namespace.
If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: JobId in: query required: true description: The ID of the request generated by the GenerateServiceLastAccessedDetails operation. TheJobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
schema:
type: string
minLength: 36
maxLength: 36
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLastAccessedDetails
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetServiceLastAccessedDetails
operationId: POST_GetServiceLastAccessedDetails
description: Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.
The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:
User – Returns the user ARN that you used to generate the report
Group – Returns the ARN of the group member (user) that last attempted to access the service
Role – Returns the role ARN that you used to generate the report
Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service
By default, the list is sorted by service namespace.
If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetServiceLastAccessedDetails - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetServiceLastAccessedDetailsWithEntities: get: x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities operationId: GET_GetServiceLastAccessedDetailsWithEntities description:After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: JobId in: query required: true description: The ID of the request generated by theGenerateServiceLastAccessedDetails operation.
schema:
type: string
minLength: 36
maxLength: 36
- name: ServiceNamespace
in: query
required: true
description: 'The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.
To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLastAccessedDetailsWithEntities
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities
operationId: POST_GetServiceLastAccessedDetailsWithEntities
description: After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetServiceLastAccessedDetailsWithEntities - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetServiceLinkedRoleDeletionStatus: get: x-aws-operation-name: GetServiceLinkedRoleDeletionStatus operationId: GET_GetServiceLinkedRoleDeletionStatus description: Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use theDeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse"
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
"481":
description: InvalidInputException
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidInputException"
"482":
description: ServiceFailureException
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceFailureException"
parameters:
- name: DeletionTaskId
in: query
required: true
description: The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
schema:
type: string
minLength: 1
maxLength: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLinkedRoleDeletionStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: GetServiceLinkedRoleDeletionStatus
operationId: POST_GetServiceLinkedRoleDeletionStatus
description: Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse"
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
"481":
description: InvalidInputException
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidInputException"
"482":
description: ServiceFailureException
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceFailureException"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/GetServiceLinkedRoleDeletionStatusRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetServiceLinkedRoleDeletionStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
/#Action=GetUser:
get:
x-aws-operation-name: GetUser
operationId: GET_GetUser
description: Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetUserResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: false description: 'The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetUser operationId: POST_GetUser description:Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetUserResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetUserRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=GetUserPolicy: get: x-aws-operation-name: GetUserPolicy operationId: GET_GetUserPolicy description:Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetUserPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the user who the policy is associated with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - GetUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetUserPolicy operationId: POST_GetUserPolicy description:Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetUserPolicyResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetUserPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - GetUserPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListAccessKeys: get: x-aws-operation-name: ListAccessKeys operationId: GET_ListAccessKeys description:Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.
The name of the user.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the group to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PathPrefix in: query required: false description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the role to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PathPrefix in: query required: false description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the user to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PathPrefix in: query required: false description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.
You can paginate the results using the MaxItems and Marker parameters.
The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: EntityFilter in: query required: false description:The entity type to use for filtering the results.
For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The policy usage method to use for filtering the results.
To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
This parameter is optional. If it is not included, all policies are returned.
schema: type: string enum: - PermissionsPolicy - PermissionsBoundary description:The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
- name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.
You can paginate the results using the MaxItems and Marker parameters.
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.
The name of the group to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
The name of the user to list groups for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
The name of the IAM instance profile whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
You can paginate the results using the MaxItems and Marker parameters.
The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
You can paginate the results using the MaxItems and Marker parameters.
Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About instance profiles.
You can paginate the results using the MaxItems and Marker parameters.
The name of the role to list instance profiles for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About instance profiles.
You can paginate the results using the MaxItems and Marker parameters.
The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems and Marker parameters.
The name of the user whose MFA devices you want to list.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems and Marker parameters.
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListOpenIDConnectProviderTagsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: OpenIDConnectProviderArn in: query required: true description: 'The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListOpenIDConnectProviderTagsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListOpenIDConnectProviderTagsRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ListOpenIDConnectProviderTags - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListOpenIDConnectProviders: get: x-aws-operation-name: ListOpenIDConnectProviders operationId: GET_ListOpenIDConnectProviders description:Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.
You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.
You can paginate the results using the MaxItems and Marker parameters.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set to All, all policies are returned.
A flag to filter the results to only the attached policies.
When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.
\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
schema:
type: string
pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
minLength: 1
maxLength: 512
- name: PolicyUsageFilter
in: query
required: false
description: The policy usage method to use for filtering the results.
To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
This parameter is optional. If it is not included, all policies are returned.
schema: type: string enum: - PermissionsPolicy - PermissionsBoundary description:The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
- name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.
You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local. To list only Amazon Web Services managed policies, set Scope to AWS.
You can paginate the results using the MaxItems and Marker parameters.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListPoliciesGrantingServiceAccessResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Arn
in: query
required: true
description: The ARN of the IAM identity (user, group, or role) whose policies you want to list.
schema:
type: string
description: The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: ServiceNamespaces in: query required: true description: 'The service namespace for the Amazon Web Services services whose policies you want to list.
To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListPoliciesGrantingServiceAccessResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListPoliciesGrantingServiceAccessRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ListPoliciesGrantingServiceAccess - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListPolicyTags: get: x-aws-operation-name: ListPolicyTags operationId: GET_ListPolicyTags description: Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListPolicyTagsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: PolicyArn in: query required: true description: 'The ARN of the IAM customer managed policy whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListPolicyVersionsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListPolicyVersionsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListPolicyVersionsRequest" parameters: - name: MaxItems in: query schema: type: string description: Pagination limit required: false - name: Marker in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - ListPolicyVersions - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListRolePolicies: get: x-aws-operation-name: ListRolePolicies operationId: GET_ListRolePolicies description:Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.
The name of the role to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.
The name of the IAM role for which you want to see the list of tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole.
You can paginate the results using the MaxItems and Marker parameters.
The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole.
You can paginate the results using the MaxItems and Marker parameters.
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListSAMLProviderTagsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" parameters: - name: SAMLProviderArn in: query required: true description: 'The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListSAMLProviderTagsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListSAMLProviderTagsRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ListSAMLProviderTags - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListSAMLProviders: get: x-aws-operation-name: ListSAMLProviders operationId: GET_ListSAMLProviders description:Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
This operation requires Signature Version 4.
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
This operation requires Signature Version 4.
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
The name of the IAM server certificate whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: ServiceName in: query required: false description: Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services. schema: type: string - name: Action in: query required: true schema: type: string enum: - ListServiceSpecificCredentials - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ListServiceSpecificCredentials operationId: POST_ListServiceSpecificCredentials description: Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentials in the CodeCommit User Guide. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ListServiceSpecificCredentialsResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ServiceNotSupportedException content: text/xml: schema: $ref: "#/components/schemas/ServiceNotSupportedException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ListServiceSpecificCredentialsRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ListServiceSpecificCredentials - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ListSigningCertificates: get: x-aws-operation-name: ListSigningCertificates operationId: GET_ListSigningCertificates description:Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
The name of the IAM user whose signing certificates you want to examine.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.
The name of the user to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.
The name of the IAM user whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Marker in: query required: false description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.
You can paginate the results using the MaxItems and Marker parameters.
The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.
You can paginate the results using the MaxItems and Marker parameters.
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
You can paginate the results using the MaxItems and Marker parameters.
Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,"
schema:
type: string
enum:
- Assigned
- Unassigned
- Any
- name: Marker
in: query
required: false
description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: MaxItems
in: query
required: false
description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
You can paginate the results using the MaxItems and Marker parameters.
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyDocument in: query required: true description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - PutRolePermissionsBoundary - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: PutRolePermissionsBoundary operationId: POST_PutRolePermissionsBoundary description:Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, see Using roles to delegate permissions and federate identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
The name of the role to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyName in: query required: true description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyDocument in: query required: true description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, see Using roles to delegate permissions and federate identities.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - PutUserPermissionsBoundary - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: PutUserPermissionsBoundary operationId: POST_PutUserPermissionsBoundary description:Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
The name of the user to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyName in: query required: true description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: PolicyDocument in: query required: true description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: OpenIDConnectProviderArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: ClientID in: query required: true description: The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider. schema: type: string minLength: 1 maxLength: 255 - name: Action in: query required: true schema: type: string enum: - RemoveClientIDFromOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RemoveClientIDFromOpenIDConnectProvider operationId: POST_RemoveClientIDFromOpenIDConnectProvider description:Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
responses: "200": description: Success "480": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RemoveClientIDFromOpenIDConnectProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - RemoveClientIDFromOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=RemoveRoleFromInstanceProfile: get: x-aws-operation-name: RemoveRoleFromInstanceProfile operationId: GET_RemoveRoleFromInstanceProfile description:Removes the specified IAM role from the specified EC2 instance profile.
Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.
For more information about IAM roles, see Working with roles. For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: RoleName in: query required: true description: 'The name of the role to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - RemoveRoleFromInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RemoveRoleFromInstanceProfile operationId: POST_RemoveRoleFromInstanceProfile description:Removes the specified IAM role from the specified EC2 instance profile.
Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.
For more information about IAM roles, see Working with roles. For more information about instance profiles, see About instance profiles.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RemoveRoleFromInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - RemoveRoleFromInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=RemoveUserFromGroup: get: x-aws-operation-name: RemoveUserFromGroup operationId: GET_RemoveUserFromGroup description: Removes the specified user from the specified group. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: GroupName in: query required: true description: 'The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: UserName in: query required: true description: 'The name of the user to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - RemoveUserFromGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RemoveUserFromGroup operationId: POST_RemoveUserFromGroup description: Removes the specified user from the specified group. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RemoveUserFromGroupRequest" parameters: - name: Action in: query required: true schema: type: string enum: - RemoveUserFromGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ResetServiceSpecificCredential: get: x-aws-operation-name: ResetServiceSpecificCredential operationId: GET_ResetServiceSpecificCredential description: Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ResetServiceSpecificCredentialResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: UserName in: query required: false description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: ServiceSpecificCredentialId in: query required: true description:The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - ResetServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ResetServiceSpecificCredential operationId: POST_ResetServiceSpecificCredential description: Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ResetServiceSpecificCredentialResponse" "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ResetServiceSpecificCredentialRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ResetServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=ResyncMFADevice: get: x-aws-operation-name: ResyncMFADevice operationId: GET_ResyncMFADevice description:Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
responses: "200": description: Success "480": description: InvalidAuthenticationCodeException content: text/xml: schema: $ref: "#/components/schemas/InvalidAuthenticationCodeException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the user whose MFA device you want to resynchronize.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: SerialNumber in: query required: true description: 'Serial number that uniquely identifies the MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: AuthenticationCode1 in: query required: true description:An authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
schema: type: string pattern: "[\\d]+" minLength: 6 maxLength: 6 - name: AuthenticationCode2 in: query required: true description:A subsequent authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
schema: type: string pattern: "[\\d]+" minLength: 6 maxLength: 6 - name: Action in: query required: true schema: type: string enum: - ResyncMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ResyncMFADevice operationId: POST_ResyncMFADevice description:Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
responses: "200": description: Success "480": description: InvalidAuthenticationCodeException content: text/xml: schema: $ref: "#/components/schemas/InvalidAuthenticationCodeException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/ResyncMFADeviceRequest" parameters: - name: Action in: query required: true schema: type: string enum: - ResyncMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=SetDefaultPolicyVersion: get: x-aws-operation-name: SetDefaultPolicyVersion operationId: GET_SetDefaultPolicyVersion description:Sets the specified version of the specified policy as the policy's default (operative) version.
This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description:The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: VersionId in: query required: true description:The version of the policy to set as the default (operative) version.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
schema: type: string pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - name: Action in: query required: true schema: type: string enum: - SetDefaultPolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SetDefaultPolicyVersion operationId: POST_SetDefaultPolicyVersion description:Sets the specified version of the specified policy as the policy's default (operative) version.
This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/SetDefaultPolicyVersionRequest" parameters: - name: Action in: query required: true schema: type: string enum: - SetDefaultPolicyVersion - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=SetSecurityTokenServicePreferences: get: x-aws-operation-name: SetSecurityTokenServicePreferences operationId: GET_SetSecurityTokenServicePreferences description:Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.
The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.
For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
schema: type: string enum: - v1Token - v2Token - name: Action in: query required: true schema: type: string enum: - SetSecurityTokenServicePreferences - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SetSecurityTokenServicePreferences operationId: POST_SetSecurityTokenServicePreferences description:Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
iam:CreateUser. This operation does not support using wildcards (*) in an action name.
schema:
type: array
items:
$ref: "#/components/schemas/ActionNameType"
- name: ResourceArns
in: query
required: false
description: A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Simulation of resource-based policies isn't supported for IAM roles.
An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.
The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
schema: type: string minLength: 1 maxLength: 2048 - name: ContextEntries in: query required: false description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. schema: type: array items: $ref: "#/components/schemas/ContextEntry" - name: ResourceHandlingOption in: query required: false description:Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore
instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet
instance, image, security group, network interface, subnet
EC2-VPC-EBS
instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet
instance, image, security group, network interface, subnet, volume
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- SimulateCustomPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: SimulateCustomPolicy
operationId: POST_SimulateCustomPolicy
description: Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: PolicyInputList in: query required: false description:An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
iam:CreateUser.
schema:
type: array
items:
$ref: "#/components/schemas/ActionNameType"
- name: ResourceArns
in: query
required: false
description: A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Simulation of resource-based policies isn't supported for IAM roles.
ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
schema:
type: string
minLength: 1
maxLength: 2048
- name: CallerArn
in: query
required: false
description: The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string minLength: 1 maxLength: 2048 - name: ContextEntries in: query required: false description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. schema: type: array items: $ref: "#/components/schemas/ContextEntry" - name: ResourceHandlingOption in: query required: false description:Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore
instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet
instance, image, security group, network interface, subnet
EC2-VPC-EBS
instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet
instance, image, security group, network interface, subnet, volume
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
schema:
type: string
pattern: "[\\u0020-\\u00FF]+"
minLength: 1
maxLength: 320
- name: Action
in: query
required: true
schema:
type: string
enum:
- SimulatePrincipalPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: SimulatePrincipalPolicy
operationId: POST_SimulatePrincipalPolicy
description: Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The name of the IAM instance profile to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagInstanceProfile operationId: POST_TagInstanceProfile description:Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagMFADevice operationId: POST_TagMFADevice description:Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The ARN of the OIDC identity provider in IAM to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Tags in: query required: true description: The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagOpenIDConnectProvider operationId: POST_TagOpenIDConnectProvider description:Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The ARN of the IAM customer managed policy to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagPolicy operationId: POST_TagPolicy description:Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name of the IAM role to which you want to add tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagRole operationId: POST_TagRole description:Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/TagRoleRequest" parameters: - name: Action in: query required: true schema: type: string enum: - TagRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=TagSAMLProvider: get: x-aws-operation-name: TagSAMLProvider operationId: GET_TagSAMLProvider description:Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The ARN of the SAML identity provider in IAM to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Tags in: query required: true description: The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagSAMLProvider operationId: POST_TagSAMLProvider description:Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation . If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
The name of the IAM server certificate to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagServerCertificate operationId: POST_TagServerCertificate description:Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Tags in: query required: true description: The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value. schema: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - TagUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TagUser operationId: POST_TagUser description:Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "483": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/TagUserRequest" parameters: - name: Action in: query required: true schema: type: string enum: - TagUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagInstanceProfile: get: x-aws-operation-name: UntagInstanceProfile operationId: GET_UntagInstanceProfile description: Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: InstanceProfileName in: query required: true description: 'The name of the IAM instance profile from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagInstanceProfile operationId: POST_UntagInstanceProfile description: Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagInstanceProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagMFADevice: get: x-aws-operation-name: UntagMFADevice operationId: GET_UntagMFADevice description: Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: SerialNumber in: query required: true description: 'The unique identifier for the IAM virtual MFA device from which you want to remove tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=/:,.@-]+" minLength: 9 maxLength: 256 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagMFADevice operationId: POST_UntagMFADevice description: Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagMFADeviceRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagMFADevice - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagOpenIDConnectProvider: get: x-aws-operation-name: UntagOpenIDConnectProvider operationId: GET_UntagOpenIDConnectProvider description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: OpenIDConnectProviderArn in: query required: true description: 'The ARN of the OIDC provider in IAM from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagOpenIDConnectProvider operationId: POST_UntagOpenIDConnectProvider description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagOpenIDConnectProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagOpenIDConnectProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagPolicy: get: x-aws-operation-name: UntagPolicy operationId: GET_UntagPolicy description: Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: PolicyArn in: query required: true description: 'The ARN of the IAM customer managed policy from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagPolicy operationId: POST_UntagPolicy description: Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagRole: get: x-aws-operation-name: UntagRole operationId: GET_UntagRole description: Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name of the IAM role from which you want to remove tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagRole operationId: POST_UntagRole description: Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagRoleRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagRole - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagSAMLProvider: get: x-aws-operation-name: UntagSAMLProvider operationId: GET_UntagSAMLProvider description: Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: SAMLProviderArn in: query required: true description: 'The ARN of the SAML identity provider in IAM from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagSAMLProvider operationId: POST_UntagSAMLProvider description: Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: InvalidInputException content: text/xml: schema: $ref: "#/components/schemas/InvalidInputException" "482": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagSAMLProviderRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UntagServerCertificate: get: x-aws-operation-name: UntagServerCertificate operationId: GET_UntagServerCertificate description:Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
The name of the IAM server certificate from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagServerCertificate operationId: POST_UntagServerCertificate description:Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificates in the IAM User Guide.
The name of the IAM user from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: TagKeys in: query required: true description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user. schema: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 - name: Action in: query required: true schema: type: string enum: - UntagUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UntagUser operationId: POST_UntagUser description: Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: ConcurrentModificationException content: text/xml: schema: $ref: "#/components/schemas/ConcurrentModificationException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UntagUserRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UntagUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UpdateAccessKey: get: x-aws-operation-name: UpdateAccessKey operationId: GET_UpdateAccessKey description:Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: false description: 'The name of the user whose key you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: AccessKeyId in: query required: true description:The access key ID of the secret access key you want to update.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 16 maxLength: 128 - name: Status in: query required: true description: " The status you want to assign to the secret access key.Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used."
schema:
type: string
enum:
- Active
- Inactive
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateAccessKey
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: UpdateAccessKey
operationId: POST_UpdateAccessKey
description: Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "482": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UpdateAccessKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UpdateAccessKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UpdateAccountPasswordPolicy: get: x-aws-operation-name: UpdateAccountPasswordPolicy operationId: GET_UpdateAccountPasswordPolicy description:Updates the password policy settings for the Amazon Web Services account.
This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: MinimumPasswordLength in: query required: false description:The minimum number of characters allowed in an IAM user password.
If you do not specify a value for this parameter, then the operation uses the default value of 6.
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.
Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.
Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.
Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.
The number of days that an IAM user password is valid.
If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.
Specifies the number of previous passwords that IAM users are prevented from reusing.
If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.
Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.
In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
Updates the password policy settings for the Amazon Web Services account.
This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UpdateAccountPasswordPolicyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UpdateAccountPasswordPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UpdateAssumeRolePolicy: get: x-aws-operation-name: UpdateAssumeRolePolicy operationId: GET_UpdateAssumeRolePolicy description: Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities. responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "481": description: MalformedPolicyDocumentException content: text/xml: schema: $ref: "#/components/schemas/MalformedPolicyDocumentException" "482": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "483": description: UnmodifiableEntityException content: text/xml: schema: $ref: "#/components/schemas/UnmodifiableEntityException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: RoleName in: query required: true description: 'The name of the role to update with the new policy.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: PolicyDocument in: query required: true description:The policy that grants an entity permission to assume the role.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.
The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.
Name of the IAM group to update. If you're changing the name of the group, this is the original name.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: NewPath in: query required: false description:New path for the IAM group. Only include this if changing the group's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
New name for the IAM group. Only include this if changing the group's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - UpdateGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateGroup operationId: POST_UpdateGroup description:Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.
The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about modifying passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success "480": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" parameters: - name: UserName in: query required: true description: 'The name of the user whose password you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Password in: query required: false description:The new password for the specified IAM user.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.
schema: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 128 format: password - name: PasswordResetRequired in: query required: false description: Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - UpdateLoginProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateLoginProfile operationId: POST_UpdateLoginProfile description:Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about modifying passwords, see Managing passwords in the IAM User Guide.
responses: "200": description: Success "480": description: EntityTemporarilyUnmodifiableException content: text/xml: schema: $ref: "#/components/schemas/EntityTemporarilyUnmodifiableException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: PasswordPolicyViolationException content: text/xml: schema: $ref: "#/components/schemas/PasswordPolicyViolationException" "483": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "484": description: ServiceFailureException content: text/xml: schema: $ref: "#/components/schemas/ServiceFailureException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UpdateLoginProfileRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UpdateLoginProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UpdateOpenIDConnectProviderThumbprint: get: x-aws-operation-name: UpdateOpenIDConnectProviderThumbprint operationId: GET_UpdateOpenIDConnectProviderThumbprint description:Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: ThumbprintList in: query required: true description: "A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. " schema: type: array description: Contains a list of thumbprints of identity provider server certificates. items: $ref: "#/components/schemas/thumbprintType" - name: Action in: query required: true schema: type: string enum: - UpdateOpenIDConnectProviderThumbprint - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateOpenIDConnectProviderThumbprint operationId: POST_UpdateOpenIDConnectProviderThumbprint description:Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
schema: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 - name: Action in: query required: true schema: type: string enum: - UpdateSAMLProvider - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateSAMLProvider operationId: POST_UpdateSAMLProvider description:Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: SSHPublicKeyId in: query required: true description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Status in: query required: true description: The status to assign to the SSH public key.Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
schema:
type: string
enum:
- Active
- Inactive
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSSHPublicKey
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: UpdateSSHPublicKey
operationId: POST_UpdateSSHPublicKey
description: Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success "480": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UpdateSSHPublicKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UpdateSSHPublicKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UpdateServerCertificate: get: x-aws-operation-name: UpdateServerCertificate operationId: GET_UpdateServerCertificate description:Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.
The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.
The name of the server certificate that you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: NewPath in: query required: false description:The new path for the server certificate. Include this only if you are updating the server certificate's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - UpdateServerCertificate - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateServerCertificate operationId: POST_UpdateServerCertificate description:Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.
The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.
Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.
responses:
"200":
description: Success
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
parameters:
- name: UserName
in: query
required: false
description: 'The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: ServiceSpecificCredentialId in: query required: true description:The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 - name: Status in: query required: true description: The status to be assigned to the service-specific credential. schema: type: string enum: - Active - Inactive - name: Action in: query required: true schema: type: string enum: - UpdateServiceSpecificCredential - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateServiceSpecificCredential operationId: POST_UpdateServiceSpecificCredential description: Sets the status of a service-specific credential toActive or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.
responses:
"200":
description: Success
"480":
description: NoSuchEntityException
content:
text/xml:
schema:
$ref: "#/components/schemas/NoSuchEntityException"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/UpdateServiceSpecificCredentialRequest"
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateServiceSpecificCredential
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
/#Action=UpdateSigningCertificate:
get:
x-aws-operation-name: UpdateSigningCertificate
operationId: GET_UpdateSigningCertificate
description: Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
The name of the IAM user the signing certificate belongs to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: CertificateId in: query required: true description:The ID of the signing certificate you want to update.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
schema: type: string pattern: "[\\w]+" minLength: 24 maxLength: 128 - name: Status in: query required: true description: " The status you want to assign to the certificate.Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used."
schema:
type: string
enum:
- Active
- Inactive
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSigningCertificate
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2010-05-08
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: UpdateSigningCertificate
operationId: POST_UpdateSigningCertificate
description: Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.
To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.
Name of the user to update. If you're changing the name of the user, this is the original user name.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: NewPath in: query required: false description:New path for the IAM user. Include this parameter only if you're changing the user's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
New name for the user. Include this parameter only if you're changing the user's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: Action in: query required: true schema: type: string enum: - UpdateUser - name: Version in: query required: true schema: type: string enum: - 2010-05-08 parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: UpdateUser operationId: POST_UpdateUser description:Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM user and Renaming an IAM group in the IAM User Guide.
To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/UploadSSHPublicKeyResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: InvalidPublicKeyException content: text/xml: schema: $ref: "#/components/schemas/InvalidPublicKeyException" "483": description: DuplicateSSHPublicKeyException content: text/xml: schema: $ref: "#/components/schemas/DuplicateSSHPublicKeyException" "484": description: UnrecognizedPublicKeyEncodingException content: text/xml: schema: $ref: "#/components/schemas/UnrecognizedPublicKeyEncodingException" parameters: - name: UserName in: query required: true description: 'The name of the IAM user to associate the SSH public key with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 - name: SSHPublicKeyBody in: query required: true description:The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/UploadSSHPublicKeyResponse" "480": description: LimitExceededException content: text/xml: schema: $ref: "#/components/schemas/LimitExceededException" "481": description: NoSuchEntityException content: text/xml: schema: $ref: "#/components/schemas/NoSuchEntityException" "482": description: InvalidPublicKeyException content: text/xml: schema: $ref: "#/components/schemas/InvalidPublicKeyException" "483": description: DuplicateSSHPublicKeyException content: text/xml: schema: $ref: "#/components/schemas/DuplicateSSHPublicKeyException" "484": description: UnrecognizedPublicKeyEncodingException content: text/xml: schema: $ref: "#/components/schemas/UnrecognizedPublicKeyEncodingException" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UploadSSHPublicKeyRequest" parameters: - name: Action in: query required: true schema: type: string enum: - UploadSSHPublicKey - name: Version in: query required: true schema: type: string enum: - 2010-05-08 /#Action=UploadServerCertificate: get: x-aws-operation-name: UploadServerCertificate operationId: GET_UploadServerCertificate description:Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.
The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).
The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: CertificateBody in: query required: true description:The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide.
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
The name of the user the signing certificate is for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 - name: CertificateBody in: query required: true description:The contents of the signing certificate.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.
Department or Cost Center are common choices.
Value:
allOf:
- $ref: "#/components/schemas/tagValueType"
- description: The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Contains a thumbprint for an identity provider's server certificate.
The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.
minLength: 40 maxLength: 40 CreatePolicyResponse: type: object properties: Policy: allOf: - $ref: "#/components/schemas/Policy" - description: A structure containing details about the new policy. description: "Contains the response to a successful CreatePolicy request. " MalformedPolicyDocumentException: {} CreatePolicyVersionResponse: type: object properties: PolicyVersion: allOf: - $ref: "#/components/schemas/PolicyVersion" - description: A structure containing details about the new policy version. description: "Contains the response to a successful CreatePolicyVersion request. " CreateRoleResponse: type: object required: - Role example: Role: Arn: arn:aws:iam::123456789012:role/Test-Role AssumeRolePolicyDocument:A structure that contains information about the newly created service-specific credential.
This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.
task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
InvalidAuthenticationCodeException: {}
GenerateCredentialReportResponse:
type: object
properties:
State:
allOf:
- $ref: "#/components/schemas/ReportStateType"
- description: Information about the state of the credential report.
Description:
allOf:
- $ref: "#/components/schemas/ReportStateDescriptionType"
- description: Information about the credential report.
description: "Contains the response to a successful GenerateCredentialReport request. "
GenerateOrganizationsAccessReportResponse:
type: object
example:
JobId: examplea-1234-b567-cde8-90fg123abcd4
properties:
JobId:
allOf:
- $ref: "#/components/schemas/jobIDType"
- description: The job identifier that you can use in the GetOrganizationsAccessReport operation.
ReportGenerationLimitExceededException: {}
GenerateServiceLastAccessedDetailsResponse:
type: object
example:
JobId: examplef-1305-c245-eba4-71fe298bcda7
properties:
JobId:
allOf:
- $ref: "#/components/schemas/jobIDType"
- description: The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
GetAccessKeyLastUsedResponse:
type: object
properties:
UserName:
allOf:
- $ref: "#/components/schemas/existingUserNameType"
- description: The name of the IAM user that owns this access key.
AccessKeyLastUsed: allOf: - $ref: "#/components/schemas/AccessKeyLastUsed" - description: Contains information about the last time the access key was used. description: Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action. GetAccountAuthorizationDetailsResponse: type: object properties: UserDetailList: allOf: - $ref: "#/components/schemas/userDetailListType" - description: A list containing information about IAM users. GroupDetailList: allOf: - $ref: "#/components/schemas/groupDetailListType" - description: A list containing information about IAM groups. RoleDetailList: allOf: - $ref: "#/components/schemas/roleDetailListType" - description: A list containing information about IAM roles. Policies: allOf: - $ref: "#/components/schemas/ManagedPolicyDetailListType" - description: A list containing information about managed policies. IsTruncated: allOf: - $ref: "#/components/schemas/booleanType" - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful GetAccountAuthorizationDetails request. "
EntityType:
type: string
enum:
- User
- Role
- Group
- LocalManagedPolicy
- AWSManagedPolicy
GetAccountPasswordPolicyResponse:
type: object
required:
- PasswordPolicy
example:
PasswordPolicy:
AllowUsersToChangePassword: false
ExpirePasswords: false
HardExpiry: false
MaxPasswordAge: 90
MinimumPasswordLength: 8
PasswordReusePrevention: 12
RequireLowercaseCharacters: false
RequireNumbers: true
RequireSymbols: true
RequireUppercaseCharacters: false
properties:
PasswordPolicy:
allOf:
- $ref: "#/components/schemas/PasswordPolicy"
- description: A structure that contains details about the account's password policy.
description: "Contains the response to a successful GetAccountPasswordPolicy request. "
GetAccountSummaryResponse:
type: object
example:
SummaryMap:
AccessKeysPerUserQuota: 2
AccountAccessKeysPresent: 1
AccountMFAEnabled: 0
AccountSigningCertificatesPresent: 0
AttachedPoliciesPerGroupQuota: 10
AttachedPoliciesPerRoleQuota: 10
AttachedPoliciesPerUserQuota: 10
GlobalEndpointTokenVersion: 2
GroupPolicySizeQuota: 5120
Groups: 15
GroupsPerUserQuota: 10
GroupsQuota: 100
MFADevices: 6
MFADevicesInUse: 3
Policies: 8
PoliciesQuota: 1000
PolicySizeQuota: 5120
PolicyVersionsInUse: 22
PolicyVersionsInUseQuota: 10000
ServerCertificates: 1
ServerCertificatesQuota: 20
SigningCertificatesPerUserQuota: 2
UserPolicySizeQuota: 2048
Users: 27
UsersQuota: 5000
VersionsPerPolicyQuota: 5
properties:
SummaryMap:
allOf:
- $ref: "#/components/schemas/summaryMapType"
- description: A set of key–value pairs containing information about IAM entity usage and IAM quotas.
description: "Contains the response to a successful GetAccountSummary request. "
GetContextKeysForPolicyResponse:
type: object
properties:
ContextKeyNames:
allOf:
- $ref: "#/components/schemas/ContextKeyNamesResultListType"
- description: The list of context keys that are referenced in the input policies.
description: "Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request. "
policyDocumentType:
type: string
pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
minLength: 1
maxLength: 131072
GetCredentialReportResponse:
type: object
properties:
Content:
allOf:
- $ref: "#/components/schemas/ReportContentType"
- description: Contains the credential report. The report is Base64-encoded.
ReportFormat:
allOf:
- $ref: "#/components/schemas/ReportFormatType"
- description: The format (MIME type) of the credential report.
GeneratedTime:
allOf:
- $ref: "#/components/schemas/dateType"
- description: ' The date and time when the credential report was created, in ISO 8601 date-time format.'
description: "Contains the response to a successful GetCredentialReport request. "
CredentialReportNotPresentException: {}
CredentialReportExpiredException: {}
CredentialReportNotReadyException: {}
GetGroupResponse:
type: object
required:
- Group
- Users
properties:
Group:
allOf:
- $ref: "#/components/schemas/Group"
- description: A structure that contains details about the group.
Users:
allOf:
- $ref: "#/components/schemas/userListType"
- description: A list of users in the group.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful GetGroup request. "
GetGroupPolicyResponse:
type: object
required:
- GroupName
- PolicyName
- PolicyDocument
properties:
GroupName:
allOf:
- $ref: "#/components/schemas/groupNameType"
- description: The group the policy is associated with.
PolicyName:
allOf:
- $ref: "#/components/schemas/policyNameType"
- description: The name of the policy.
PolicyDocument:
allOf:
- $ref: "#/components/schemas/policyDocumentType"
- description: The policy document.
IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
description: "Contains the response to a successful GetGroupPolicy request. " GetInstanceProfileResponse: type: object required: - InstanceProfile example: InstanceProfile: Arn: arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile CreateDate: 2013-06-12T23:52:02Z InstanceProfileId: AID2MAB8DPLSRHEXAMPLE InstanceProfileName: ExampleInstanceProfile Path: / Roles: - Arn: arn:aws:iam::336924118301:role/Test-Role AssumeRolePolicyDocument:The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.
This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.
Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/markerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ErrorDetails:
$ref: "#/components/schemas/ErrorDetails"
GetPolicyResponse:
type: object
properties:
Policy:
allOf:
- $ref: "#/components/schemas/Policy"
- description: A structure containing details about the policy.
description: "Contains the response to a successful GetPolicy request. "
GetPolicyVersionResponse:
type: object
properties:
PolicyVersion:
allOf:
- $ref: "#/components/schemas/PolicyVersion"
- description: A structure containing details about the policy version.
description: "Contains the response to a successful GetPolicyVersion request. "
GetRoleResponse:
type: object
required:
- Role
example:
Role:
Arn: arn:aws:iam::123456789012:role/Test-Role
AssumeRolePolicyDocument: The policy document.
IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
description: "Contains the response to a successful GetRolePolicy request. " GetSAMLProviderResponse: type: object properties: SAMLMetadataDocument: allOf: - $ref: "#/components/schemas/SAMLMetadataDocumentType" - description: The XML metadata document that includes information about an identity provider. CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time when the SAML provider was created. ValidUntil: allOf: - $ref: "#/components/schemas/dateType" - description: The expiration date and time for the SAML provider. Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description: "Contains the response to a successful GetSAMLProvider request. " GetSSHPublicKeyResponse: type: object properties: SSHPublicKey: allOf: - $ref: "#/components/schemas/SSHPublicKey" - description: A structure containing details about the SSH public key. description: Contains the response to a successful GetSSHPublicKey request. UnrecognizedPublicKeyEncodingException: {} GetServerCertificateResponse: type: object required: - ServerCertificate properties: ServerCertificate: allOf: - $ref: "#/components/schemas/ServerCertificate" - description: A structure containing details about the server certificate. description: "Contains the response to a successful GetServerCertificate request. " GetServiceLastAccessedDetailsResponse: type: object required: - JobStatus - JobCreationDate - ServicesLastAccessed - JobCompletionDate example: IsTruncated: false JobCompletionDate: 2018-10-24T19:47:35.241Z JobCreationDate: 2018-10-24T19:47:31.466Z JobStatus: COMPLETED ServicesLastAccessed: - LastAuthenticated: 2018-10-24T19:11:00Z LastAuthenticatedEntity: arn:aws:iam::123456789012:user/AWSExampleUser01 ServiceName: AWS Identity and Access Management ServiceNamespace: iam TotalAuthenticatedEntities: 2 - ServiceName: Amazon Simple Storage Service ServiceNamespace: s3 TotalAuthenticatedEntities: 0 properties: JobStatus: allOf: - $ref: "#/components/schemas/jobStatusType" - description: The status of the job. JobType: allOf: - $ref: "#/components/schemas/AccessAdvisorUsageGranularityType" - description: The type of job. Service jobs return information about when each service was last accessed. Action jobs also include information about when tracked actions within the service were last accessed. JobCreationDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the report job was created. ServicesLastAccessed: allOf: - $ref: "#/components/schemas/ServicesLastAccessed" - description: " AServiceLastAccessed object that contains details about the most recent attempt to access the service."
JobCompletionDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.
This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.
Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Error:
allOf:
- $ref: "#/components/schemas/ErrorDetails"
- description: An object that contains details about the reason the operation failed.
GetServiceLastAccessedDetailsWithEntitiesResponse:
type: object
required:
- JobStatus
- JobCreationDate
- JobCompletionDate
- EntityDetailsList
example:
EntityDetailsList:
- EntityInfo:
Arn: arn:aws:iam::123456789012:user/AWSExampleUser01
Id: AIDAEX2EXAMPLEB6IGCDC
Name: AWSExampleUser01
Path: /
Type: USER
LastAuthenticated: 2018-10-24T19:10:00Z
- EntityInfo:
Arn: arn:aws:iam::123456789012:role/AWSExampleRole01
Id: AROAEAEXAMPLEIANXSIU4
Name: AWSExampleRole01
Path: /
Type: ROLE
IsTruncated: false
JobCompletionDate: 2018-10-24T19:47:35.241Z
JobCreationDate: 2018-10-24T19:47:31.466Z
JobStatus: COMPLETED
properties:
JobStatus:
allOf:
- $ref: "#/components/schemas/jobStatusType"
- description: The status of the job.
JobCreationDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the report job was created.
JobCompletionDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.
This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.
EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified Amazon Web Services service.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
Error:
allOf:
- $ref: "#/components/schemas/ErrorDetails"
- description: An object that contains details about the reason the operation failed.
GetServiceLinkedRoleDeletionStatusResponse:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: "#/components/schemas/DeletionTaskStatusType"
- description: The status of the deletion.
Reason:
allOf:
- $ref: "#/components/schemas/DeletionTaskFailureReasonType"
- description: An object that contains details about the reason the deletion failed.
GetUserResponse:
type: object
required:
- User
example:
User:
Arn: arn:aws:iam::123456789012:user/Bob
CreateDate: 2012-09-21T23:03:13Z
Path: /
UserId: AKIAIOSFODNN7EXAMPLE
UserName: Bob
properties:
User:
allOf:
- $ref: "#/components/schemas/User"
- description: A structure containing details about the IAM user.
Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this operation. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.
You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to Amazon Web Services in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access Amazon Web Services programmatically you can refer to access key last used information because it is accurate for all dates.
The policy document.
IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
description: "Contains the response to a successful GetUserPolicy request. " ListAccessKeysResponse: type: object required: - AccessKeyMetadata example: AccessKeyMetadata: - AccessKeyId: AKIA111111111EXAMPLE CreateDate: 2016-12-01T22:19:58Z Status: Active UserName: Alice - AccessKeyId: AKIA222222222EXAMPLE CreateDate: 2016-12-01T22:20:01Z Status: Active UserName: Alice properties: AccessKeyMetadata: allOf: - $ref: "#/components/schemas/accessKeyMetadataListType" - description: A list of objects containing metadata about the access keys. IsTruncated: allOf: - $ref: "#/components/schemas/booleanType" - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListAccessKeys request. "
ListAccountAliasesResponse:
type: object
required:
- AccountAliases
example:
AccountAliases:
- exmaple-corporation
properties:
AccountAliases:
allOf:
- $ref: "#/components/schemas/accountAliasListType"
- description: A list of aliases associated with the account. Amazon Web Services supports only one alias per account.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListAccountAliases request. "
ListAttachedGroupPoliciesResponse:
type: object
properties:
AttachedPolicies:
allOf:
- $ref: "#/components/schemas/attachedPoliciesListType"
- description: A list of the attached policies.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListAttachedGroupPolicies request. "
ListAttachedRolePoliciesResponse:
type: object
properties:
AttachedPolicies:
allOf:
- $ref: "#/components/schemas/attachedPoliciesListType"
- description: A list of the attached policies.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListAttachedRolePolicies request. "
ListAttachedUserPoliciesResponse:
type: object
properties:
AttachedPolicies:
allOf:
- $ref: "#/components/schemas/attachedPoliciesListType"
- description: A list of the attached policies.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListAttachedUserPolicies request. "
ListEntitiesForPolicyResponse:
type: object
properties:
PolicyGroups:
allOf:
- $ref: "#/components/schemas/PolicyGroupListType"
- description: A list of IAM groups that the policy is attached to.
PolicyUsers:
allOf:
- $ref: "#/components/schemas/PolicyUserListType"
- description: A list of IAM users that the policy is attached to.
PolicyRoles:
allOf:
- $ref: "#/components/schemas/PolicyRoleListType"
- description: A list of IAM roles that the policy is attached to.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListEntitiesForPolicy request. "
ListGroupPoliciesResponse:
type: object
required:
- PolicyNames
example:
PolicyNames:
- AdminRoot
- KeyPolicy
properties:
PolicyNames:
allOf:
- $ref: "#/components/schemas/policyNameListType"
- description: 'A list of policy names.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' IsTruncated: allOf: - $ref: "#/components/schemas/booleanType" - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListGroupPolicies request. "
ListGroupsResponse:
type: object
required:
- Groups
example:
Groups:
- Arn: arn:aws:iam::123456789012:group/Admins
CreateDate: 2016-12-15T21:40:08.121Z
GroupId: AGPA1111111111EXAMPLE
GroupName: Admins
Path: /division_abc/subdivision_xyz/
- Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test
CreateDate: 2016-11-30T14:10:01.156Z
GroupId: AGP22222222222EXAMPLE
GroupName: Test
Path: /division_abc/subdivision_xyz/product_1234/engineering/
- Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers
CreateDate: 2016-06-12T20:14:52.032Z
GroupId: AGPI3333333333EXAMPLE
GroupName: Managers
Path: /division_abc/subdivision_xyz/product_1234/
properties:
Groups:
allOf:
- $ref: "#/components/schemas/groupListType"
- description: A list of groups.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListGroups request. "
ListGroupsForUserResponse:
type: object
required:
- Groups
example:
Groups:
- Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test
CreateDate: 2016-11-30T14:10:01.156Z
GroupId: AGP2111111111EXAMPLE
GroupName: Test
Path: /division_abc/subdivision_xyz/product_1234/engineering/
- Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers
CreateDate: 2016-06-12T20:14:52.032Z
GroupId: AGPI222222222SEXAMPLE
GroupName: Managers
Path: /division_abc/subdivision_xyz/product_1234/
properties:
Groups:
allOf:
- $ref: "#/components/schemas/groupListType"
- description: A list of groups.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListGroupsForUser request. "
ListInstanceProfileTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the IAM instance profile. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListInstanceProfilesResponse:
type: object
required:
- InstanceProfiles
properties:
InstanceProfiles:
allOf:
- $ref: "#/components/schemas/instanceProfileListType"
- description: A list of instance profiles.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListInstanceProfiles request. "
ListInstanceProfilesForRoleResponse:
type: object
required:
- InstanceProfiles
properties:
InstanceProfiles:
allOf:
- $ref: "#/components/schemas/instanceProfileListType"
- description: A list of instance profiles.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListInstanceProfilesForRole request. "
ListMFADeviceTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the virtual MFA device. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListMFADevicesResponse:
type: object
required:
- MFADevices
properties:
MFADevices:
allOf:
- $ref: "#/components/schemas/mfaDeviceListType"
- description: A list of MFA devices.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListMFADevices request. "
ListOpenIDConnectProviderTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the OpenID Connect (OIDC) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListOpenIDConnectProvidersResponse:
type: object
properties:
OpenIDConnectProviderList:
allOf:
- $ref: "#/components/schemas/OpenIDConnectProviderListType"
- description: The list of IAM OIDC provider resource objects defined in the Amazon Web Services account.
description: "Contains the response to a successful ListOpenIDConnectProviders request. "
ListPoliciesResponse:
type: object
properties:
Policies:
allOf:
- $ref: "#/components/schemas/policyListType"
- description: A list of policies.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListPolicies request. "
ListPoliciesGrantingServiceAccessResponse:
type: object
required:
- PoliciesGrantingServiceAccess
example:
IsTruncated: false
PoliciesGrantingServiceAccess:
- Policies:
- PolicyArn: arn:aws:iam::123456789012:policy/ExampleIamPolicy
PolicyName: ExampleIamPolicy
PolicyType: MANAGED
- EntityName: AWSExampleGroup1
EntityType: GROUP
PolicyName: ExampleGroup1Policy
PolicyType: INLINE
ServiceNamespace: iam
- Policies:
- PolicyArn: arn:aws:iam::123456789012:policy/ExampleEc2Policy
PolicyName: ExampleEc2Policy
PolicyType: MANAGED
ServiceNamespace: ec2
properties:
PoliciesGrantingServiceAccess:
allOf:
- $ref: "#/components/schemas/listPolicyGrantingServiceAccessResponseListType"
- description: A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role).
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
serviceNamespaceType:
type: string
pattern: "[\\w-]*"
minLength: 1
maxLength: 64
ListPolicyTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the IAM customer managed policy. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListPolicyVersionsResponse:
type: object
properties:
Versions:
allOf:
- $ref: "#/components/schemas/policyDocumentVersionListType"
- description: A list of policy versions.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
IsTruncated: allOf: - $ref: "#/components/schemas/booleanType" - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListPolicyVersions request. "
ListRolePoliciesResponse:
type: object
required:
- PolicyNames
properties:
PolicyNames:
allOf:
- $ref: "#/components/schemas/policyNameListType"
- description: A list of policy names.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListRolePolicies request. "
ListRoleTagsResponse:
type: object
required:
- Tags
example:
IsTruncated: false
Tags:
- Key: Dept
Value: "12345"
- Key: Team
Value: Accounting
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListRolesResponse:
type: object
required:
- Roles
properties:
Roles:
allOf:
- $ref: "#/components/schemas/roleListType"
- description: A list of roles.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListRoles request. "
ListSAMLProviderTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListSAMLProvidersResponse:
type: object
properties:
SAMLProviderList:
allOf:
- $ref: "#/components/schemas/SAMLProviderListType"
- description: The list of SAML provider resource objects defined in IAM for this Amazon Web Services account.
description: "Contains the response to a successful ListSAMLProviders request. "
ListSSHPublicKeysResponse:
type: object
properties:
SSHPublicKeys:
allOf:
- $ref: "#/components/schemas/SSHPublicKeyListType"
- description: A list of the SSH public keys assigned to IAM user.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: Contains the response to a successful ListSSHPublicKeys request.
ListServerCertificateTagsResponse:
type: object
required:
- Tags
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the IAM server certificate. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListServerCertificatesResponse:
type: object
required:
- ServerCertificateMetadataList
properties:
ServerCertificateMetadataList:
allOf:
- $ref: "#/components/schemas/serverCertificateMetadataListType"
- description: A list of server certificates.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListServerCertificates request. "
ListServiceSpecificCredentialsResponse:
type: object
properties:
ServiceSpecificCredentials:
allOf:
- $ref: "#/components/schemas/ServiceSpecificCredentialsListType"
- description: A list of structures that each contain details about a service-specific credential.
ListSigningCertificatesResponse:
type: object
required:
- Certificates
example:
Certificates:
- CertificateBody: -----BEGIN CERTIFICATE-----Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListSigningCertificates request. "
ListUserPoliciesResponse:
type: object
required:
- PolicyNames
properties:
PolicyNames:
allOf:
- $ref: "#/components/schemas/policyNameListType"
- description: A list of policy names.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListUserPolicies request. "
ListUserTagsResponse:
type: object
required:
- Tags
example:
IsTruncated: false
Tags:
- Key: Dept
Value: "12345"
- Key: Team
Value: Accounting
properties:
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
ListUsersResponse:
type: object
required:
- Users
example:
Users:
- Arn: arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan
CreateDate: 2012-09-05T19:38:48Z
PasswordLastUsed: 2016-09-08T21:47:36Z
Path: /division_abc/subdivision_xyz/engineering/
UserId: AID2MAB8DPLSRHEXAMPLE
UserName: Juan
- Arn: arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika
CreateDate: 2014-04-09T15:43:45Z
PasswordLastUsed: 2016-09-24T16:18:07Z
Path: /division_abc/subdivision_xyz/engineering/
UserId: AIDIODR4TAW7CSEXAMPLE
UserName: Anika
properties:
Users:
allOf:
- $ref: "#/components/schemas/userListType"
- description: A list of users.
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListUsers request. "
ListVirtualMFADevicesResponse:
type: object
required:
- VirtualMFADevices
example:
VirtualMFADevices:
- SerialNumber: arn:aws:iam::123456789012:mfa/ExampleMFADevice
- SerialNumber: arn:aws:iam::123456789012:mfa/Juan
properties:
VirtualMFADevices:
allOf:
- $ref: "#/components/schemas/virtualMFADeviceListType"
- description: " The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request."
IsTruncated:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: "Contains the response to a successful ListVirtualMFADevices request. "
ResetServiceSpecificCredentialResponse:
type: object
properties:
ServiceSpecificCredential:
allOf:
- $ref: "#/components/schemas/ServiceSpecificCredential"
- description: A structure with details about the updated service-specific credential, including the new password.
This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.
Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
Marker:
allOf:
- $ref: "#/components/schemas/responseMarkerType"
- description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
description: Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
ActionNameType:
type: string
minLength: 3
maxLength: 128
ResourceNameType:
type: string
minLength: 1
maxLength: 2048
ContextEntry:
type: object
properties:
ContextKeyName:
allOf:
- $ref: "#/components/schemas/ContextKeyNameType"
- description: The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.
ContextKeyValues:
allOf:
- $ref: "#/components/schemas/ContextKeyValueListType"
- description: The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.
ContextKeyType:
allOf:
- $ref: "#/components/schemas/ContextKeyTypeEnum"
- description: The data type of the value (or values) specified in the ContextKeyValues parameter.
description: Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.
PolicyEvaluationException: {} tagKeyType: type: string pattern: "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" minLength: 1 maxLength: 128 UpdateRoleResponse: type: object properties: {} UpdateRoleDescriptionResponse: type: object properties: Role: allOf: - $ref: "#/components/schemas/Role" - description: A structure that contains details about the modified role. UpdateSAMLProviderResponse: type: object properties: SAMLProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: The Amazon Resource Name (ARN) of the SAML provider that was updated. description: "Contains the response to a successful UpdateSAMLProvider request. " UploadSSHPublicKeyResponse: type: object properties: SSHPublicKey: allOf: - $ref: "#/components/schemas/SSHPublicKey" - description: Contains information about the SSH public key. description: Contains the response to a successful UploadSSHPublicKey request. InvalidPublicKeyException: {} DuplicateSSHPublicKeyException: {} UploadServerCertificateResponse: type: object example: ServerCertificateMetadata: Arn: arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert Expiration: 2012-05-08T01:02:03.004Z Path: /company/servercerts/ ServerCertificateId: ASCA1111111111EXAMPLE ServerCertificateName: ProdServerCert UploadDate: 2010-05-08T01:02:03.004Z properties: ServerCertificateMetadata: allOf: - $ref: "#/components/schemas/ServerCertificateMetadata" - description: The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key. Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description: "Contains the response to a successful UploadServerCertificate request. " MalformedCertificateException: {} KeyPairMismatchException: {} UploadSigningCertificateResponse: type: object required: - Certificate example: Certificate: CertificateBody: -----BEGIN CERTIFICATE-----The namespace of the service in which access was attempted.
To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
The Region where the last service access attempt occurred.
This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.
EntityPath: allOf: - $ref: "#/components/schemas/organizationsEntityPathType" - description:The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
This field is null if no principals (IAM users, IAM roles, or root user) in the reported Organizations entity attempted to access the service within the tracking period.
LastAuthenticatedTime: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.
This field is null if no principals in the reported Organizations entity attempted to access the service within the tracking period.
TotalAuthenticatedEntities: allOf: - $ref: "#/components/schemas/integerType" - description: The number of accounts with authenticated principals (root user, IAM users, and IAM roles) that attempted to access the service in the tracking period. description:An object that contains details about when a principal in the reported Organizations entity last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role, or the Amazon Web Services account root user within the reported Organizations entity.
This data type is a response element in the GetOrganizationsAccessReport operation.
AccessDetails: type: array items: $ref: "#/components/schemas/AccessDetail" userNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 accessKeyIdType: type: string pattern: "[\\w]+" minLength: 16 maxLength: 128 statusType: type: string enum: - Active - Inactive accessKeySecretType: type: string format: password AccessKey: type: object required: - UserName - AccessKeyId - Status - SecretAccessKey properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name of the IAM user that the access key is associated with. AccessKeyId: allOf: - $ref: "#/components/schemas/accessKeyIdType" - description: The ID for this access key. Status: allOf: - $ref: "#/components/schemas/statusType" - description: "The status of the access key.Active means that the key is valid for API calls, while Inactive means it is not. "
SecretAccessKey:
allOf:
- $ref: "#/components/schemas/accessKeySecretType"
- description: The secret key used to sign requests.
CreateDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date when the access key was created.
description: Contains information about an Amazon Web Services access key.
This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.
The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.
The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:
The user does not have an access key.
An access key exists but has not been used since IAM began tracking this information.
There is no sign-in data associated with the user.
The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is "N/A" in the following situations:
The user does not have an access key.
An access key exists but has not been used since IAM started tracking this information.
There is no sign-in data associated with the user.
The Amazon Web Services Region where this access key was most recently used. The value for this field is "N/A" in the following situations:
The user does not have an access key.
An access key exists but has not been used since IAM began tracking this information.
There is no sign-in data associated with the user.
For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services General Reference.
description:Contains information about the last time an Amazon Web Services access key was used since IAM began tracking this information on April 22, 2015.
This data type is used as a response element in the GetAccessKeyLastUsed operation.
AccessKeyMetadata: type: object properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name of the IAM user that the key is associated with. AccessKeyId: allOf: - $ref: "#/components/schemas/accessKeyIdType" - description: The ID for this access key. Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status of the access key.Active means that the key is valid for API calls; Inactive means it is not.
CreateDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date when the access key was created.
description: Contains information about an Amazon Web Services access key, without its secret key.
This data type is used as a response element in the ListAccessKeys operation.
ActionNameListType: type: array items: $ref: "#/components/schemas/ActionNameType" arnType: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 AddClientIDToOpenIDConnectProviderRequest: type: object required: - OpenIDConnectProviderArn - ClientID title: AddClientIDToOpenIDConnectProviderRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation. ClientID: allOf: - $ref: "#/components/schemas/clientIDType" - description: The client ID (also known as audience) to add to the IAM OpenID Connect provider resource. instanceProfileNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 roleNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 64 AddRoleToInstanceProfileRequest: type: object required: - InstanceProfileName - RoleName title: AddRoleToInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the role to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' groupNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 existingUserNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 AddUserToGroupRequest: type: object required: - GroupName - UserName title: AddUserToGroupRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to add.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ArnListType: type: array items: $ref: "#/components/schemas/arnType" AttachGroupPolicyRequest: type: object required: - GroupName - PolicyArn title: AttachGroupPolicyRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name (friendly name, not ARN) of the group to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
AttachRolePolicyRequest: type: object required: - RoleName - PolicyArn title: AttachRolePolicyRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name (friendly name, not ARN) of the role to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
AttachUserPolicyRequest: type: object required: - UserName - PolicyArn title: AttachUserPolicyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name (friendly name, not ARN) of the IAM user to attach the policy to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to attach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
PermissionsBoundaryAttachmentType: type: string enum: - PermissionsBoundaryPolicy AttachedPermissionsBoundary: type: object properties: PermissionsBoundaryType: allOf: - $ref: "#/components/schemas/PermissionsBoundaryAttachmentType" - description: " The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value ofPolicy."
PermissionsBoundaryArn:
allOf:
- $ref: "#/components/schemas/arnType"
- description: " The ARN of the policy used to set the permissions boundary for the user or role."
description: Contains information about an attached permissions boundary.
An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
policyNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 AttachedPolicy: type: object properties: PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: The friendly name of the attached policy. PolicyArn: $ref: "#/components/schemas/arnType" description:Contains information about an attached policy.
An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
BootstrapDatum: type: string format: password passwordType: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 128 format: password ChangePasswordRequest: type: object required: - OldPassword - NewPassword title: ChangePasswordRequest properties: OldPassword: allOf: - $ref: "#/components/schemas/passwordType" - description: The IAM user's current password. NewPassword: allOf: - $ref: "#/components/schemas/passwordType" - description:The new password. The new password must conform to the Amazon Web Services account's password policy, if one exists.
The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.
The name of the IAM user that the new key will belong to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' accountAliasType: type: string pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ minLength: 3 maxLength: 63 CreateAccountAliasRequest: type: object required: - AccountAlias title: CreateAccountAliasRequest properties: AccountAlias: allOf: - $ref: "#/components/schemas/accountAliasType" - description:The account alias to create.
This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
pathType: type: string pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) minLength: 1 maxLength: 512 CreateGroupRequest: type: object required: - GroupName title: CreateGroupRequest properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description:The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the group to create. Do not include the path in this value.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
Group: type: object required: - Path - GroupName - GroupId - Arn - CreateDate properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description: 'The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide. ' GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: The friendly name that identifies the group. GroupId: allOf: - $ref: "#/components/schemas/idType" - description: ' The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide. ' Arn: allOf: - $ref: "#/components/schemas/arnType" - description: ' The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide. ' CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the group was created. description:Contains information about an IAM group entity.
This data type is used as a response element in the following operations:
tagListType: type: array items: $ref: "#/components/schemas/Tag" maxItems: 50 CreateInstanceProfileRequest: type: object required: - InstanceProfileName title: CreateInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the instance profile to create.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Path: allOf: - $ref: "#/components/schemas/pathType" - description:The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
A list of tags that you want to attach to the newly created IAM instance profile. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Contains information about an instance profile.
This data type is used as a response element in the following operations:
booleanType: type: boolean CreateLoginProfileRequest: type: object required: - UserName - Password title: CreateLoginProfileRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user to create a password for. The user must already exist.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Password: allOf: - $ref: "#/components/schemas/passwordType" - description:The new password for the user.
The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\u0020) through the end of the ASCII character range (\u00FF). You can also include the tab (\u0009), line feed (\u000A), and carriage return (\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.
Contains the user name and password create date for a user.
This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.
OpenIDConnectProviderUrlType: type: string description: Contains a URL that specifies the endpoint for an OpenID Connect provider. minLength: 1 maxLength: 255 clientIDListType: type: array items: $ref: "#/components/schemas/clientIDType" thumbprintListType: type: array description: Contains a list of thumbprints of identity provider server certificates. items: $ref: "#/components/schemas/thumbprintType" CreateOpenIDConnectProviderRequest: type: object required: - Url - ThumbprintList title: CreateOpenIDConnectProviderRequest properties: Url: allOf: - $ref: "#/components/schemas/OpenIDConnectProviderUrlType" - description:The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. The URL should not contain a port number.
You cannot register the same provider multiple times in a single Amazon Web Services account. If you try to submit a URL that has already been used for an OpenID Connect provider in the Amazon Web Services account, you will get an error.
ClientIDList: allOf: - $ref: "#/components/schemas/clientIDListType" - description:Provides a list of client IDs, also known as audiences. When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. This is the value that's sent as the client_id parameter on OAuth requests.
You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.
For more information about obtaining the OIDC provider thumbprint, see Obtaining the thumbprint for an OpenID Connect provider in the IAM user Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
The friendly name of the policy.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
Path: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path for the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
You cannot use an asterisk (*) in the path name.
The JSON policy document that you want to use as the content for the new policy.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
A friendly description of the policy.
Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
The policy description is immutable. After a value is assigned, it cannot be changed.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
The stable and unique string identifying the policy.
For more information about IDs, see IAM identifiers in the IAM User Guide.
Arn: $ref: "#/components/schemas/arnType" Path: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path to the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
DefaultVersionId: allOf: - $ref: "#/components/schemas/policyVersionIdType" - description: The identifier for the version of the policy that is set as the default version. AttachmentCount: allOf: - $ref: "#/components/schemas/attachmentCountType" - description: The number of entities (users, groups, and roles) that the policy is attached to. PermissionsBoundaryUsageCount: allOf: - $ref: "#/components/schemas/attachmentCountType" - description:The number of entities (users and roles) for which the policy is used to set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
IsAttachable: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether the policy can be attached to an IAM user, group, or role. Description: allOf: - $ref: "#/components/schemas/policyDescriptionType" - description:A friendly description of the policy.
This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.
CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the policy was created. UpdateDate: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description:Contains information about a managed policy.
This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
CreatePolicyVersionRequest: type: object required: - PolicyArn - PolicyDocument title: CreatePolicyVersionRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The JSON policy document that you want to use as the content for this new version of the policy.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Specifies whether to set this version as the policy's default version.
When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
PolicyVersion: type: object properties: Document: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The policy document.
The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.
The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
The identifier for the policy version.
Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.
Contains information about a version of a managed policy.
This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
roleDescriptionType: type: string pattern: "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" maxLength: 1000 roleMaxSessionDurationType: type: integer minimum: 3600 maximum: 43200 CreateRoleRequest: type: object required: - RoleName - AssumeRolePolicyDocument title: CreateRoleRequest properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description:The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the role to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' AssumeRolePolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Upon success, the response includes the same trust policy in JSON format.
Description: allOf: - $ref: "#/components/schemas/roleDescriptionType" - description: A description of the role. MaxSessionDuration: allOf: - $ref: "#/components/schemas/roleMaxSessionDurationType" - description:The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
DurationSeconds API parameter or duration-seconds CLI parameter.
PermissionsBoundary:
allOf:
- $ref: "#/components/schemas/AttachedPermissionsBoundary"
- description: The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. RoleLastUsed: allOf: - $ref: "#/components/schemas/RoleLastUsed" - description: Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide. description: Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles. SAMLMetadataDocumentType: type: string minLength: 1000 maxLength: 10000000 SAMLProviderNameType: type: string pattern: "[\\w._-]+" minLength: 1 maxLength: 128 CreateSAMLProviderRequest: type: object required: - SAMLMetadataDocument - Name title: CreateSAMLProviderRequest properties: SAMLMetadataDocument: allOf: - $ref: "#/components/schemas/SAMLMetadataDocumentType" - description:An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
For more information, see About SAML 2.0-based federation in the IAM User Guide
Name: allOf: - $ref: "#/components/schemas/SAMLProviderNameType" - description: 'The name of the provider to create.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see Amazon Web Services services that work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.
' Description: allOf: - $ref: "#/components/schemas/roleDescriptionType" - description: The description of the role. CustomSuffix: allOf: - $ref: "#/components/schemas/customSuffixType" - description:A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.
Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.
The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServiceName: allOf: - $ref: "#/components/schemas/serviceName" - description: The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials. ServiceSpecificCredential: type: object required: - CreateDate - ServiceName - ServiceUserName - ServicePassword - ServiceSpecificCredentialId - UserName - Status properties: CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the service-specific credential were created. ServiceName: allOf: - $ref: "#/components/schemas/serviceName" - description: The name of the service associated with the service-specific credential. ServiceUserName: allOf: - $ref: "#/components/schemas/serviceUserName" - description: The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as injane-at-123456789012, for example. This value cannot be configured by the user.
ServicePassword:
allOf:
- $ref: "#/components/schemas/servicePassword"
- description: The generated password for the service-specific credential.
ServiceSpecificCredentialId:
allOf:
- $ref: "#/components/schemas/serviceSpecificCredentialId"
- description: The unique identifier for the service-specific credential.
UserName:
allOf:
- $ref: "#/components/schemas/userNameType"
- description: The name of the IAM user associated with the service-specific credential.
Status:
allOf:
- $ref: "#/components/schemas/statusType"
- description: The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.
description: Contains the details of a service-specific credential.
CreateUserRequest:
type: object
required:
- UserName
title: CreateUserRequest
properties:
Path:
allOf:
- $ref: "#/components/schemas/pathType"
- description: The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the user to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
PermissionsBoundary: allOf: - $ref: "#/components/schemas/arnType" - description:The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide.
The ARN of the policy used to set the permissions boundary for the user.
UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The friendly name identifying the user. UserId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide. Arn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide. ' CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the user was created. PasswordLastUsed: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user's last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:
The user never had a password.
A password exists but has not been used since IAM started tracking this information on October 20, 2014.
A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.
This value is returned only in the GetUser and ListUsers operations.
PermissionsBoundary: allOf: - $ref: "#/components/schemas/AttachedPermissionsBoundary" - description: For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide. Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description:Contains information about an IAM user entity.
This data type is used as a response element in the following operations:
virtualMFADeviceName: type: string pattern: "[\\w+=,.@-]+" minLength: 1 CreateVirtualMFADeviceRequest: type: object required: - VirtualMFADeviceName title: CreateVirtualMFADeviceRequest properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description:The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description:A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
VirtualMFADevice.
Base32StringSeed:
allOf:
- $ref: "#/components/schemas/BootstrapDatum"
- description: ' The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded. '
QRCodePNG:
allOf:
- $ref: "#/components/schemas/BootstrapDatum"
- description: " A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded. "
User:
allOf:
- $ref: "#/components/schemas/User"
- description: The IAM user associated with this virtual MFA device.
EnableDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time on which the virtual MFA device was enabled.
Tags:
allOf:
- $ref: "#/components/schemas/tagListType"
- description: A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
description: Contains information about a virtual MFA device.
serialNumberType:
type: string
pattern: "[\\w+=/:,.@-]+"
minLength: 9
maxLength: 256
DeactivateMFADeviceRequest:
type: object
required:
- UserName
- SerialNumber
title: DeactivateMFADeviceRequest
properties:
UserName:
allOf:
- $ref: "#/components/schemas/existingUserNameType"
- description: 'The name of the user whose MFA device you want to deactivate.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' DeleteAccessKeyRequest: type: object required: - AccessKeyId title: DeleteAccessKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user whose access key pair you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' AccessKeyId: allOf: - $ref: "#/components/schemas/accessKeyIdType" - description:The access key ID for the access key ID and secret access key you want to delete.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
DeleteAccountAliasRequest: type: object required: - AccountAlias title: DeleteAccountAliasRequest properties: AccountAlias: allOf: - $ref: "#/components/schemas/accountAliasType" - description:The name of the account alias to delete.
This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.
DeleteGroupPolicyRequest: type: object required: - GroupName - PolicyName title: DeleteGroupPolicyRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name (friendly name, not ARN) identifying the group that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name identifying the policy document to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteGroupRequest: type: object required: - GroupName title: DeleteGroupRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name of the IAM group to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteInstanceProfileRequest: type: object required: - InstanceProfileName title: DeleteInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the instance profile to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteLoginProfileRequest: type: object required: - UserName title: DeleteLoginProfileRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the user whose password you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteOpenIDConnectProviderRequest: type: object required: - OpenIDConnectProviderArn title: DeleteOpenIDConnectProviderRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation. DeletePolicyRequest: type: object required: - PolicyArn title: DeletePolicyRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to delete.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
policyVersionIdType: type: string pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? DeletePolicyVersionRequest: type: object required: - PolicyArn - VersionId title: DeletePolicyVersionRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
VersionId: allOf: - $ref: "#/components/schemas/policyVersionIdType" - description:The policy version to delete.
This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
DeleteRolePermissionsBoundaryRequest: type: object required: - RoleName title: DeleteRolePermissionsBoundaryRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary. DeleteRolePolicyRequest: type: object required: - RoleName - PolicyName title: DeleteRolePolicyRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name (friendly name, not ARN) identifying the role that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the inline policy to delete from the specified IAM role.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteRoleRequest: type: object required: - RoleName title: DeleteRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the role to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteSAMLProviderRequest: type: object required: - SAMLProviderArn title: DeleteSAMLProviderRequest properties: SAMLProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: The Amazon Resource Name (ARN) of the SAML provider to delete. publicKeyIdType: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 DeleteSSHPublicKeyRequest: type: object required: - UserName - SSHPublicKeyId title: DeleteSSHPublicKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SSHPublicKeyId: allOf: - $ref: "#/components/schemas/publicKeyIdType" - description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
serverCertificateNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 DeleteServerCertificateRequest: type: object required: - ServerCertificateName title: DeleteServerCertificateRequest properties: ServerCertificateName: allOf: - $ref: "#/components/schemas/serverCertificateNameType" - description: 'The name of the server certificate you want to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteServiceLinkedRoleRequest: type: object required: - RoleName title: DeleteServiceLinkedRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The name of the service-linked role to be deleted. DeletionTaskIdType: type: string minLength: 1 maxLength: 1000 serviceSpecificCredentialId: type: string pattern: "[\\w]+" minLength: 20 maxLength: 128 DeleteServiceSpecificCredentialRequest: type: object required: - ServiceSpecificCredentialId title: DeleteServiceSpecificCredentialRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServiceSpecificCredentialId: allOf: - $ref: "#/components/schemas/serviceSpecificCredentialId" - description:The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
certificateIdType: type: string pattern: "[\\w]+" minLength: 24 maxLength: 128 DeleteSigningCertificateRequest: type: object required: - CertificateId title: DeleteSigningCertificateRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user the signing certificate belongs to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' CertificateId: allOf: - $ref: "#/components/schemas/certificateIdType" - description:The ID of the signing certificate to delete.
The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.
DeleteUserPermissionsBoundaryRequest: type: object required: - UserName title: DeleteUserPermissionsBoundaryRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary. DeleteUserPolicyRequest: type: object required: - UserName - PolicyName title: DeleteUserPolicyRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name (friendly name, not ARN) identifying the user that the policy is embedded in.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name identifying the policy document to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteUserRequest: type: object required: - UserName title: DeleteUserRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to delete.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' DeleteVirtualMFADeviceRequest: type: object required: - SerialNumber title: DeleteVirtualMFADeviceRequest properties: SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' ReasonType: type: string maxLength: 1000 RoleUsageListType: type: array items: $ref: "#/components/schemas/RoleUsageType" DeletionTaskFailureReasonType: type: object properties: Reason: allOf: - $ref: "#/components/schemas/ReasonType" - description: A short description of the reason that the service-linked role deletion failed. RoleUsageList: allOf: - $ref: "#/components/schemas/RoleUsageListType" - description: A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used. description:The reason that the service-linked role deletion failed.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
DeletionTaskStatusType: type: string enum: - SUCCEEDED - IN_PROGRESS - FAILED - NOT_STARTED DetachGroupPolicyRequest: type: object required: - GroupName - PolicyArn title: DetachGroupPolicyRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name (friendly name, not ARN) of the IAM group to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
DetachRolePolicyRequest: type: object required: - RoleName - PolicyArn title: DetachRolePolicyRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name (friendly name, not ARN) of the IAM role to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
DetachUserPolicyRequest: type: object required: - UserName - PolicyArn title: DetachUserPolicyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name (friendly name, not ARN) of the IAM user to detach the policy from.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy you want to detach.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
authenticationCodeType: type: string pattern: "[\\d]+" minLength: 6 maxLength: 6 EnableMFADeviceRequest: type: object required: - UserName - SerialNumber - AuthenticationCode1 - AuthenticationCode2 title: EnableMFADeviceRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the IAM user for whom you want to enable the MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-
' AuthenticationCode1: allOf: - $ref: "#/components/schemas/authenticationCodeType" - description:An authentication code emitted by the device.
The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
A subsequent authentication code emitted by the device.
The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
Contains details about the specified entity (user or role).
This data type is an element of the EntityDetails object.
EntityDetails: type: object required: - EntityInfo properties: EntityInfo: allOf: - $ref: "#/components/schemas/EntityInfo" - description: TheEntityInfo object that contains details about the entity (user or role).
LastAuthenticated:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
description:An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.
This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.
policyOwnerEntityType: type: string enum: - USER - ROLE - GROUP idType: type: string pattern: "[\\w]+" minLength: 16 maxLength: 128 ErrorDetails: type: object required: - Message - Code properties: Message: allOf: - $ref: "#/components/schemas/stringType" - description: Detailed information about the reason that the operation failed. Code: allOf: - $ref: "#/components/schemas/stringType" - description: The error code associated with the operation failure. description:Contains information about the reason that the operation failed.
This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.
PolicyEvaluationDecisionType: type: string enum: - allowed - explicitDeny - implicitDeny EvalDecisionDetailsType: type: object additionalProperties: $ref: "#/components/schemas/PolicyEvaluationDecisionType" EvalDecisionSourceType: type: string minLength: 3 maxLength: 256 StatementListType: type: array items: $ref: "#/components/schemas/Statement" OrganizationsDecisionDetail: type: object properties: AllowedByOrganizations: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether the simulated operation is allowed by the Organizations service control policies that impact the simulated user's account. description: Contains information about the effect that Organizations has on a policy simulation. PermissionsBoundaryDecisionDetail: type: object properties: AllowedByPermissionsBoundary: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role). A value oftrue means that the permissions boundary does not deny the action. This means that the policy includes an Allow statement that matches the request. In this case, if an identity-based policy also allows the action, the request is allowed. A value of false means that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.
description: Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
ResourceSpecificResultListType:
type: array
items:
$ref: "#/components/schemas/ResourceSpecificResult"
EvaluationResult:
type: object
required:
- EvalActionName
- EvalDecision
properties:
EvalActionName:
allOf:
- $ref: "#/components/schemas/ActionNameType"
- description: The name of the API operation tested on the indicated resource.
EvalResourceName:
allOf:
- $ref: "#/components/schemas/ResourceNameType"
- description: The ARN of the resource that the indicated API operation was tested on.
EvalDecision:
allOf:
- $ref: "#/components/schemas/PolicyEvaluationDecisionType"
- description: The result of the simulation.
MatchedStatements:
allOf:
- $ref: "#/components/schemas/StatementListType"
- description: A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
MissingContextValues:
allOf:
- $ref: "#/components/schemas/ContextKeyNamesResultListType"
- description: A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
OrganizationsDecisionDetail:
allOf:
- $ref: "#/components/schemas/OrganizationsDecisionDetail"
- description: A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.
PermissionsBoundaryDecisionDetail:
allOf:
- $ref: "#/components/schemas/PermissionsBoundaryDecisionDetail"
- description: Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
EvalDecisionDetails:
allOf:
- $ref: "#/components/schemas/EvalDecisionDetailsType"
- description: Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.
If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*), then the parameter is not returned.
When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true. For more information about how policies are evaluated, see Evaluating policies within a single account.
If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.
ResourceSpecificResults: allOf: - $ref: "#/components/schemas/ResourceSpecificResultListType" - description: The individual results of the simulation of the API operation specified in EvalActionName on each resource. description:Contains the results of a simulation.
This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .
123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
OrganizationsPolicyId:
allOf:
- $ref: "#/components/schemas/organizationsPolicyIdType"
- description: The identifier of the Organizations service control policy (SCP). This parameter is optional.
This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an Amazon Web Services service.
jobIDType: type: string minLength: 36 maxLength: 36 GenerateServiceLastAccessedDetailsRequest: type: object required: - Arn title: GenerateServiceLastAccessedDetailsRequest properties: Arn: allOf: - $ref: "#/components/schemas/arnType" - description: The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an Amazon Web Services service. Granularity: allOf: - $ref: "#/components/schemas/AccessAdvisorUsageGranularityType" - description: The level of detail that you want to generate. You can specify whether you want to generate information about the last attempt to access services or actions. If you specify service-level granularity, this operation generates only service data. If you specify action-level granularity, it generates service and action data. If you don't include this optional parameter, the operation generates service data. GetAccessKeyLastUsedRequest: type: object required: - AccessKeyId title: GetAccessKeyLastUsedRequest properties: AccessKeyId: allOf: - $ref: "#/components/schemas/accessKeyIdType" - description:The identifier of an access key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
entityListType: type: array items: $ref: "#/components/schemas/EntityType" maxItemsType: type: integer minimum: 1 maximum: 1000 markerType: type: string pattern: "[\\u0020-\\u00FF]+" minLength: 1 maxLength: 320 GetAccountAuthorizationDetailsRequest: type: object title: GetAccountAuthorizationDetailsRequest properties: Filter: allOf: - $ref: "#/components/schemas/entityListType" - description:A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.
The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.
MaxItems: allOf: - $ref: "#/components/schemas/maxItemsType" - description:Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
userDetailListType:
type: array
items:
$ref: "#/components/schemas/UserDetail"
groupDetailListType:
type: array
items:
$ref: "#/components/schemas/GroupDetail"
roleDetailListType:
type: array
items:
$ref: "#/components/schemas/RoleDetail"
ManagedPolicyDetailListType:
type: array
items:
$ref: "#/components/schemas/ManagedPolicyDetail"
responseMarkerType:
type: string
PasswordPolicy:
type: object
properties:
MinimumPasswordLength:
allOf:
- $ref: "#/components/schemas/minimumPasswordLengthType"
- description: Minimum length to require for IAM user passwords.
RequireSymbols:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: "Specifies whether IAM user passwords must contain at least one of the following symbols:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
" RequireNumbers: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). RequireUppercaseCharacters: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether IAM user passwords must contain at least one uppercase character (A to Z). RequireLowercaseCharacters: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether IAM user passwords must contain at least one lowercase character (a to z). AllowUsersToChangePassword: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions toiam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.
ExpirePasswords:
allOf:
- $ref: "#/components/schemas/booleanType"
- description: Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
MaxPasswordAge:
allOf:
- $ref: "#/components/schemas/maxPasswordAgeType"
- description: The number of days that an IAM user password is valid.
PasswordReusePrevention:
allOf:
- $ref: "#/components/schemas/passwordReusePreventionType"
- description: Specifies the number of previous passwords that IAM users are prevented from reusing.
HardExpiry:
allOf:
- $ref: "#/components/schemas/booleanObjectType"
- description: Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
description: Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy operation.
summaryMapType: type: object additionalProperties: $ref: "#/components/schemas/summaryValueType" SimulationPolicyListType: type: array items: $ref: "#/components/schemas/policyDocumentType" GetContextKeysForCustomPolicyRequest: type: object required: - PolicyInputList title: GetContextKeysForCustomPolicyRequest properties: PolicyInputList: allOf: - $ref: "#/components/schemas/SimulationPolicyListType" - description:A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
PolicyInputList: allOf: - $ref: "#/components/schemas/SimulationPolicyListType" - description:An optional list of additional policies for which you want the list of context keys that are referenced.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The name of the group the policy is associated with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetGroupRequest: type: object required: - GroupName title: GetGroupRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name of the group.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of users.
This data type is used as a response element in the GetGroup and ListUsers operations.
items: $ref: "#/components/schemas/User" GetInstanceProfileRequest: type: object required: - InstanceProfileName title: GetInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the instance profile to get information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetLoginProfileRequest: type: object required: - UserName title: GetLoginProfileRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the user whose login profile you want to retrieve.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetOpenIDConnectProviderRequest: type: object required: - OpenIDConnectProviderArn title: GetOpenIDConnectProviderRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
sortKeyType: type: string enum: - SERVICE_NAMESPACE_ASCENDING - SERVICE_NAMESPACE_DESCENDING - LAST_AUTHENTICATED_TIME_ASCENDING - LAST_AUTHENTICATED_TIME_DESCENDING GetOrganizationsAccessReportRequest: type: object required: - JobId title: GetOrganizationsAccessReportRequest properties: JobId: allOf: - $ref: "#/components/schemas/jobIDType" - description: The identifier of the request generated by the GenerateOrganizationsAccessReport operation. MaxItems: allOf: - $ref: "#/components/schemas/maxItemsType" - description:Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
SortKey:
allOf:
- $ref: "#/components/schemas/sortKeyType"
- description: The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
jobStatusType:
type: string
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
GetPolicyRequest:
type: object
required:
- PolicyArn
title: GetPolicyRequest
properties:
PolicyArn:
allOf:
- $ref: "#/components/schemas/arnType"
- description: The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
GetPolicyVersionRequest: type: object required: - PolicyArn - VersionId title: GetPolicyVersionRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the managed policy that you want information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
VersionId: allOf: - $ref: "#/components/schemas/policyVersionIdType" - description:Identifies the policy version to retrieve.
This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.
GetRolePolicyRequest: type: object required: - RoleName - PolicyName title: GetRolePolicyRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the role associated with the policy.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetRoleRequest: type: object required: - RoleName title: GetRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the IAM role to get information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetSAMLProviderRequest: type: object required: - SAMLProviderArn title: GetSAMLProviderRequest properties: SAMLProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
encodingType: type: string enum: - SSH - PEM GetSSHPublicKeyRequest: type: object required: - UserName - SSHPublicKeyId - Encoding title: GetSSHPublicKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SSHPublicKeyId: allOf: - $ref: "#/components/schemas/publicKeyIdType" - description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Encoding: allOf: - $ref: "#/components/schemas/encodingType" - description: Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, useSSH. To retrieve the public key in PEM format, use PEM.
SSHPublicKey:
type: object
required:
- UserName
- SSHPublicKeyId
- Fingerprint
- SSHPublicKeyBody
- Status
properties:
UserName:
allOf:
- $ref: "#/components/schemas/userNameType"
- description: The name of the IAM user associated with the SSH public key.
SSHPublicKeyId:
allOf:
- $ref: "#/components/schemas/publicKeyIdType"
- description: The unique identifier for the SSH public key.
Fingerprint:
allOf:
- $ref: "#/components/schemas/publicKeyFingerprintType"
- description: The MD5 message digest of the SSH public key.
SSHPublicKeyBody:
allOf:
- $ref: "#/components/schemas/publicKeyMaterialType"
- description: The SSH public key.
Status:
allOf:
- $ref: "#/components/schemas/statusType"
- description: The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
UploadDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
description: Contains information about an SSH public key.
This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.
GetServerCertificateRequest: type: object required: - ServerCertificateName title: GetServerCertificateRequest properties: ServerCertificateName: allOf: - $ref: "#/components/schemas/serverCertificateNameType" - description: 'The name of the server certificate you want to retrieve information about.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServerCertificate: type: object required: - ServerCertificateMetadata - CertificateBody properties: ServerCertificateMetadata: allOf: - $ref: "#/components/schemas/ServerCertificateMetadata" - description: The meta information of the server certificate, such as its name, path, ID, and ARN. CertificateBody: allOf: - $ref: "#/components/schemas/certificateBodyType" - description: The contents of the public key certificate. CertificateChain: allOf: - $ref: "#/components/schemas/certificateChainType" - description: The contents of the public key certificate chain. Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description:Contains information about a server certificate.
This data type is used as a response element in the GetServerCertificate operation.
GetServiceLastAccessedDetailsRequest: type: object required: - JobId title: GetServiceLastAccessedDetailsRequest properties: JobId: allOf: - $ref: "#/components/schemas/jobIDType" - description: The ID of the request generated by the GenerateServiceLastAccessedDetails operation. TheJobId returned by GenerateServiceLastAccessedDetail must be used by the same role within a session, or by the same user when used to call GetServiceLastAccessedDetail.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
ServicesLastAccessed:
type: array
items:
$ref: "#/components/schemas/ServiceLastAccessed"
GetServiceLastAccessedDetailsWithEntitiesRequest:
type: object
required:
- JobId
- ServiceNamespace
title: GetServiceLastAccessedDetailsWithEntitiesRequest
properties:
JobId:
allOf:
- $ref: "#/components/schemas/jobIDType"
- description: The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
ServiceNamespace:
allOf:
- $ref: "#/components/schemas/serviceNamespaceType"
- description: 'The service namespace for an Amazon Web Services service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.
To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
entityDetailsListType:
type: array
items:
$ref: "#/components/schemas/EntityDetails"
GetServiceLinkedRoleDeletionStatusRequest:
type: object
required:
- DeletionTaskId
title: GetServiceLinkedRoleDeletionStatusRequest
properties:
DeletionTaskId:
allOf:
- $ref: "#/components/schemas/DeletionTaskIdType"
- description: The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
GetUserPolicyRequest:
type: object
required:
- UserName
- PolicyName
title: GetUserPolicyRequest
properties:
UserName:
allOf:
- $ref: "#/components/schemas/existingUserNameType"
- description: 'The name of the user who the policy is associated with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document to get.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' GetUserRequest: type: object title: GetUserRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to get information about.
This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' policyDetailListType: type: array items: $ref: "#/components/schemas/PolicyDetail" attachedPoliciesListType: type: array items: $ref: "#/components/schemas/AttachedPolicy" GroupDetail: type: object properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description: The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide. GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: The friendly name that identifies the group. GroupId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide. Arn: $ref: "#/components/schemas/arnType" CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the group was created. GroupPolicyList: allOf: - $ref: "#/components/schemas/policyDetailListType" - description: A list of the inline policies embedded in the group. AttachedManagedPolicies: allOf: - $ref: "#/components/schemas/attachedPoliciesListType" - description: A list of the managed policies attached to the group. description:Contains information about an IAM group, including all of the group's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
roleListType: type: array description:Contains a list of IAM roles.
This data type is used as a response element in the ListRoles operation.
items: $ref: "#/components/schemas/Role" LineNumber: type: integer ListAccessKeysRequest: type: object title: ListAccessKeysRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of access key metadata.
This data type is used as a response element in the ListAccessKeys operation.
items: $ref: "#/components/schemas/AccessKeyMetadata" ListAccountAliasesRequest: type: object title: ListAccountAliasesRequest properties: Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name (friendly name, not ARN) of the group to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PathPrefix: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name (friendly name, not ARN) of the role to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PathPrefix: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name (friendly name, not ARN) of the user to list attached policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PathPrefix: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
ListEntitiesForPolicyRequest: type: object required: - PolicyArn title: ListEntitiesForPolicyRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
EntityFilter: allOf: - $ref: "#/components/schemas/EntityType" - description:The entity type to use for filtering the results.
For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The policy usage method to use for filtering the results.
To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
This parameter is optional. If it is not included, all policies are returned.
Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the group to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of policy names.
This data type is used as a response element in the ListPolicies operation.
items: $ref: "#/components/schemas/policyNameType" ListGroupsForUserRequest: type: object required: - UserName title: ListGroupsForUserRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to list groups for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of IAM groups.
This data type is used as a response element in the ListGroups operation.
items: $ref: "#/components/schemas/Group" pathPrefixType: type: string pattern: \u002F[\u0021-\u007F]* minLength: 1 maxLength: 512 ListGroupsRequest: type: object title: ListGroupsRequest properties: PathPrefix: allOf: - $ref: "#/components/schemas/pathPrefixType" - description: The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the IAM instance profile whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the role to list instance profiles for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the user whose MFA devices you want to list.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of MFA devices.
This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices operations.
items: $ref: "#/components/schemas/MFADevice" ListOpenIDConnectProviderTagsRequest: type: object required: - OpenIDConnectProviderArn title: ListOpenIDConnectProviderTagsRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The namespace of the service that was accessed.
To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
PoliciesGrantingServiceAccess object that contains details about the policy.
description: Contains details about the permissions policies that are attached to the specified identity (user, group, or role).
This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.
serviceNamespaceListType: type: array items: $ref: "#/components/schemas/serviceNamespaceType" minItems: 1 maxItems: 200 ListPoliciesGrantingServiceAccessRequest: type: object required: - Arn - ServiceNamespaces title: ListPoliciesGrantingServiceAccessRequest properties: Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
Arn:
allOf:
- $ref: "#/components/schemas/arnType"
- description: The ARN of the IAM identity (user, group, or role) whose policies you want to list.
ServiceNamespaces:
allOf:
- $ref: "#/components/schemas/serviceNamespaceListType"
- description: 'The service namespace for the Amazon Web Services services whose policies you want to list.
To learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services service namespaces in the Amazon Web Services General Reference.
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set to All, all policies are returned.
A flag to filter the results to only the attached policies.
When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.
\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
PolicyUsageFilter:
allOf:
- $ref: "#/components/schemas/PolicyUsageType"
- description: The policy usage method to use for filtering the results.
To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
This parameter is optional. If it is not included, all policies are returned.
Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The ARN of the IAM customer managed policy whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the role to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the IAM role for which you want to see the list of tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the IAM server certificate whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServiceName: allOf: - $ref: "#/components/schemas/serviceName" - description: Filters the returned results to only those for the specified Amazon Web Services service. If not specified, then Amazon Web Services returns service-specific credentials for all services. ServiceSpecificCredentialsListType: type: array items: $ref: "#/components/schemas/ServiceSpecificCredentialMetadata" ListSigningCertificatesRequest: type: object title: ListSigningCertificatesRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the IAM user whose signing certificates you want to examine.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains a list of signing certificates.
This data type is used as a response element in the ListSigningCertificates operation.
items: $ref: "#/components/schemas/SigningCertificate" ListUserPoliciesRequest: type: object required: - UserName title: ListUserPoliciesRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to list policies for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The name of the IAM user whose tags you want to see.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Marker: allOf: - $ref: "#/components/schemas/markerType" - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of theMarker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,"
Marker:
allOf:
- $ref: "#/components/schemas/markerType"
- description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
MaxItems:
allOf:
- $ref: "#/components/schemas/maxItemsType"
- description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Contains information about an MFA device.
This data type is used as a response element in the ListMFADevices operation.
attachmentCountType: type: integer ManagedPolicyDetail: type: object properties: PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: The friendly name (not ARN) identifying the policy. PolicyId: allOf: - $ref: "#/components/schemas/idType" - description:The stable and unique string identifying the policy.
For more information about IDs, see IAM identifiers in the IAM User Guide.
Arn: $ref: "#/components/schemas/arnType" Path: allOf: - $ref: "#/components/schemas/policyPathType" - description:The path to the policy.
For more information about paths, see IAM identifiers in the IAM User Guide.
DefaultVersionId: allOf: - $ref: "#/components/schemas/policyVersionIdType" - description:The identifier for the version of the policy that is set as the default (operative) version.
For more information about policy versions, see Versioning for managed policies in the IAM User Guide.
AttachmentCount: allOf: - $ref: "#/components/schemas/attachmentCountType" - description: The number of principal entities (users, groups, and roles) that the policy is attached to. PermissionsBoundaryUsageCount: allOf: - $ref: "#/components/schemas/attachmentCountType" - description:The number of entities (users and roles) for which the policy is used as the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
IsAttachable: allOf: - $ref: "#/components/schemas/booleanType" - description: Specifies whether the policy can be attached to an IAM user, group, or role. Description: allOf: - $ref: "#/components/schemas/policyDescriptionType" - description: A friendly description of the policy. CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the policy was created. UpdateDate: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when the policy was last updated.
When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
PolicyVersionList: allOf: - $ref: "#/components/schemas/policyDocumentVersionListType" - description: A list containing information about the versions of the policy. description:Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
OpenIDConnectProviderListEntry: type: object properties: Arn: $ref: "#/components/schemas/arnType" description: Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider. minimumPasswordLengthType: type: integer minimum: 6 maximum: 128 maxPasswordAgeType: type: integer minimum: 1 maximum: 1095 passwordReusePreventionType: type: integer minimum: 1 maximum: 24 booleanObjectType: type: boolean PolicyDetail: type: object properties: PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: The name of the policy. PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description: The policy document. description:Contains information about an IAM policy, including the policy document.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
policyType: type: string enum: - INLINE - MANAGED entityNameType: type: string pattern: "[\\w+=,.@-]+" minLength: 1 maxLength: 128 PolicyGrantingServiceAccess: type: object required: - PolicyName - PolicyType properties: PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: The policy name. PolicyType: allOf: - $ref: "#/components/schemas/policyType" - description: The policy type. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide. PolicyArn: $ref: "#/components/schemas/arnType" EntityType: allOf: - $ref: "#/components/schemas/policyOwnerEntityType" - description:The type of entity (user or role) that used the policy to access the service to which the inline policy is attached.
This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
EntityName: allOf: - $ref: "#/components/schemas/entityNameType" - description:The name of the entity (user or role) to which the inline policy is attached.
This field is null for managed policies. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.
description:Contains details about the permissions policies that are attached to the specified identity (user, group, or role).
This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.
PolicyGroup: type: object properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: The name (friendly name, not ARN) identifying the group. GroupId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide. description:Contains information about a group that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy operation.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
PolicyIdentifierType: type: string PolicyRole: type: object properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The name (friendly name, not ARN) identifying the role. RoleId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide. description:Contains information about a role that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy operation.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
PolicySourceType: type: string enum: - user - group - role - aws-managed - user-managed - resource - none PolicyUser: type: object properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name (friendly name, not ARN) identifying the user. UserId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide. description:Contains information about a user that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy operation.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
Position: type: object properties: Line: allOf: - $ref: "#/components/schemas/LineNumber" - description: The line containing the specified position in the document. Column: allOf: - $ref: "#/components/schemas/ColumnNumber" - description: The column in the line containing the specified position in the document. description:Contains the row and column of a location of a Statement element in a policy document.
This data type is used as a member of the Statement type.
The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
PutRolePolicyRequest: type: object required: - RoleName - PolicyName - PolicyDocument title: PutRolePolicyRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the role to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
PutUserPolicyRequest: type: object required: - UserName - PolicyName - PolicyDocument title: PutUserPolicyRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyName: allOf: - $ref: "#/components/schemas/policyNameType" - description: 'The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
ClientID: allOf: - $ref: "#/components/schemas/clientIDType" - description: The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider. RemoveRoleFromInstanceProfileRequest: type: object required: - InstanceProfileName - RoleName title: RemoveRoleFromInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the instance profile to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the role to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' RemoveUserFromGroupRequest: type: object required: - GroupName - UserName title: RemoveUserFromGroupRequest properties: GroupName: allOf: - $ref: "#/components/schemas/groupNameType" - description: 'The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ResetServiceSpecificCredentialRequest: type: object required: - ServiceSpecificCredentialId title: ResetServiceSpecificCredentialRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServiceSpecificCredentialId: allOf: - $ref: "#/components/schemas/serviceSpecificCredentialId" - description:The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
ResourceHandlingOptionType: type: string minLength: 1 maxLength: 64 ResourceNameListType: type: array items: $ref: "#/components/schemas/ResourceNameType" ResourceSpecificResult: type: object required: - EvalResourceName - EvalResourceDecision properties: EvalResourceName: allOf: - $ref: "#/components/schemas/ResourceNameType" - description: The name of the simulated resource, in Amazon Resource Name (ARN) format. EvalResourceDecision: allOf: - $ref: "#/components/schemas/PolicyEvaluationDecisionType" - description: The result of the simulation of the simulated API operation on the resource specified inEvalResourceName.
MatchedStatements:
allOf:
- $ref: "#/components/schemas/StatementListType"
- description: A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
MissingContextValues:
allOf:
- $ref: "#/components/schemas/ContextKeyNamesResultListType"
- description: A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
EvalDecisionDetails:
allOf:
- $ref: "#/components/schemas/EvalDecisionDetailsType"
- description: Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.
PermissionsBoundaryDecisionDetail:
allOf:
- $ref: "#/components/schemas/PermissionsBoundaryDecisionDetail"
- description: Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.
description: Contains the result of the simulation of a single API operation call on a single resource.
This data type is used by a member of the EvaluationResult data type.
ResyncMFADeviceRequest: type: object required: - UserName - SerialNumber - AuthenticationCode1 - AuthenticationCode2 title: ResyncMFADeviceRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user whose MFA device you want to resynchronize.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'Serial number that uniquely identifies the MFA device.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' AuthenticationCode1: allOf: - $ref: "#/components/schemas/authenticationCodeType" - description:An authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
AuthenticationCode2: allOf: - $ref: "#/components/schemas/authenticationCodeType" - description:A subsequent authentication code emitted by the device.
The format for this parameter is a sequence of six digits.
RoleLastUsed: type: object properties: LastUsedDate: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format that the role was last used.
This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.
Region: allOf: - $ref: "#/components/schemas/stringType" - description: The name of the Amazon Web Services Region in which the role was last used. description:Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
This data type is returned as a response element in the GetRole and GetAccountAuthorizationDetails operations.
RoleDetail: type: object properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description: The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide. RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The friendly name that identifies the role. RoleId: allOf: - $ref: "#/components/schemas/idType" - description: The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide. Arn: $ref: "#/components/schemas/arnType" CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time, in ISO 8601 date-time format, when the role was created. AssumeRolePolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description: The trust policy that grants permission to assume the role. InstanceProfileList: allOf: - $ref: "#/components/schemas/instanceProfileListType" - description: A list of instance profiles that contain this role. RolePolicyList: allOf: - $ref: "#/components/schemas/policyDetailListType" - description: A list of inline policies embedded in the role. These policies are the role's access (permissions) policies. AttachedManagedPolicies: allOf: - $ref: "#/components/schemas/attachedPoliciesListType" - description: A list of managed policies attached to the role. These policies are the role's access (permissions) policies. PermissionsBoundary: allOf: - $ref: "#/components/schemas/AttachedPermissionsBoundary" - description:The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. RoleLastUsed: allOf: - $ref: "#/components/schemas/RoleLastUsed" - description: Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM User Guide. description:Contains information about an IAM role, including all of the role's policies.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
RoleUsageType: type: object properties: Region: allOf: - $ref: "#/components/schemas/RegionNameType" - description: The name of the Region where the service-linked role is being used. Resources: allOf: - $ref: "#/components/schemas/ArnListType" - description: The name of the resource that is using the service-linked role. description:An object that contains details about how a service-linked role is used, if that information is returned by the service.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
SAMLProviderListEntry: type: object properties: Arn: allOf: - $ref: "#/components/schemas/arnType" - description: The Amazon Resource Name (ARN) of the SAML provider. ValidUntil: allOf: - $ref: "#/components/schemas/dateType" - description: The expiration date and time for the SAML provider. CreateDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date and time when the SAML provider was created. description: Contains the list of SAML providers for this account. publicKeyFingerprintType: type: string pattern: "[:\\w]+" minLength: 48 maxLength: 48 publicKeyMaterialType: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 16384 SSHPublicKeyMetadata: type: object required: - UserName - SSHPublicKeyId - Status - UploadDate properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name of the IAM user associated with the SSH public key. SSHPublicKeyId: allOf: - $ref: "#/components/schemas/publicKeyIdType" - description: The unique identifier for the SSH public key. Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status of the SSH public key.Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
UploadDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
description: Contains information about an SSH public key, without the key's body or fingerprint.
This data type is used as a response element in the ListSSHPublicKeys operation.
ServerCertificateMetadata: type: object required: - Path - ServerCertificateName - ServerCertificateId - Arn properties: Path: allOf: - $ref: "#/components/schemas/pathType" - description: ' The path to the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide. ' ServerCertificateName: allOf: - $ref: "#/components/schemas/serverCertificateNameType" - description: The name that identifies the server certificate. ServerCertificateId: allOf: - $ref: "#/components/schemas/idType" - description: ' The stable and unique string identifying the server certificate. For more information about IDs, see IAM identifiers in the IAM User Guide. ' Arn: allOf: - $ref: "#/components/schemas/arnType" - description: ' The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide. ' UploadDate: allOf: - $ref: "#/components/schemas/dateType" - description: The date when the server certificate was uploaded. Expiration: allOf: - $ref: "#/components/schemas/dateType" - description: The date on which the certificate is set to expire. description:Contains information about a server certificate without its certificate body, certificate chain, and private key.
This data type is used as a response element in the UploadServerCertificate and ListServerCertificates operations.
certificateBodyType: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 16384 certificateChainType: type: string pattern: "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" minLength: 1 maxLength: 2097152 TrackedActionsLastAccessed: type: array items: $ref: "#/components/schemas/TrackedActionLastAccessed" ServiceLastAccessed: type: object required: - ServiceName - ServiceNamespace properties: ServiceName: allOf: - $ref: "#/components/schemas/serviceNameType" - description: The name of the service in which access was attempted. LastAuthenticated: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
ServiceNamespace: allOf: - $ref: "#/components/schemas/serviceNamespaceType" - description: 'The namespace of the service in which access was attempted.
To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services in the Service Authorization Reference. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
The ARN of the authenticated entity (user or role) that last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
LastAuthenticatedRegion: allOf: - $ref: "#/components/schemas/stringType" - description:The Region from which the authenticated entity (user or role) last attempted to access the service. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
TotalAuthenticatedEntities: allOf: - $ref: "#/components/schemas/integerType" - description:The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.
This field is null if no principals attempted to access the service within the tracking period.
TrackedActionsLastAccessed: allOf: - $ref: "#/components/schemas/TrackedActionsLastAccessed" - description:An object that contains details about the most recent attempt to access a tracked action within the service.
This field is null if there no tracked actions or if the principal did not use the tracked actions within the tracking period. This field is also null if the report was generated at the service level and not the action level. For more information, see the Granularity field in GenerateServiceLastAccessedDetails.
Contains details about the most recent attempt to access the service.
This data type is used as a response element in the GetServiceLastAccessedDetails operation.
serviceUserName: type: string pattern: "[\\w+=,.@-]+" minLength: 17 maxLength: 200 servicePassword: type: string format: password ServiceSpecificCredentialMetadata: type: object required: - UserName - Status - ServiceUserName - CreateDate - ServiceSpecificCredentialId - ServiceName properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name of the IAM user associated with the service-specific credential. Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status of the service-specific credential.Active means that the key is valid for API calls, while Inactive means it is not.
ServiceUserName:
allOf:
- $ref: "#/components/schemas/serviceUserName"
- description: The generated user name for the service-specific credential.
CreateDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date and time, in ISO 8601 date-time format, when the service-specific credential were created.
ServiceSpecificCredentialId:
allOf:
- $ref: "#/components/schemas/serviceSpecificCredentialId"
- description: The unique identifier for the service-specific credential.
ServiceName:
allOf:
- $ref: "#/components/schemas/serviceName"
- description: The name of the service associated with the service-specific credential.
description: Contains additional details about a service-specific credential.
SetDefaultPolicyVersionRequest:
type: object
required:
- PolicyArn
- VersionId
title: SetDefaultPolicyVersionRequest
properties:
PolicyArn:
allOf:
- $ref: "#/components/schemas/arnType"
- description: The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
VersionId: allOf: - $ref: "#/components/schemas/policyVersionIdType" - description:The version of the policy to set as the default (operative) version.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
globalEndpointTokenVersion: type: string enum: - v1Token - v2Token SetSecurityTokenServicePreferencesRequest: type: object required: - GlobalEndpointTokenVersion title: SetSecurityTokenServicePreferencesRequest properties: GlobalEndpointTokenVersion: allOf: - $ref: "#/components/schemas/globalEndpointTokenVersion" - description:The version of the global endpoint token. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.
For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
SigningCertificate: type: object required: - UserName - CertificateId - CertificateBody - Status properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: The name of the user the signing certificate is associated with. CertificateId: allOf: - $ref: "#/components/schemas/certificateIdType" - description: The ID for the signing certificate. CertificateBody: allOf: - $ref: "#/components/schemas/certificateBodyType" - description: The contents of the signing certificate. Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status of the signing certificate.Active means that the key is valid for API calls, while Inactive means it is not.
UploadDate:
allOf:
- $ref: "#/components/schemas/dateType"
- description: The date when the signing certificate was uploaded.
description: Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.
SimulateCustomPolicyRequest: type: object required: - PolicyInputList - ActionNames title: SimulateCustomPolicyRequest properties: PolicyInputList: allOf: - $ref: "#/components/schemas/SimulationPolicyListType" - description:A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
iam:CreateUser. This operation does not support using wildcards (*) in an action name.
ResourceArns:
allOf:
- $ref: "#/components/schemas/ResourceNameListType"
- description: A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Simulation of resource-based policies isn't supported for IAM roles.
An ARN representing the Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.
The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
ContextEntries: allOf: - $ref: "#/components/schemas/ContextEntryListType" - description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. ResourceHandlingOption: allOf: - $ref: "#/components/schemas/ResourceHandlingOptionType" - description:Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore
instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet
instance, image, security group, network interface, subnet
EC2-VPC-EBS
instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet
instance, image, security group, network interface, subnet, volume
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
SimulatePrincipalPolicyRequest:
type: object
required:
- PolicySourceArn
- ActionNames
title: SimulatePrincipalPolicyRequest
properties:
PolicySourceArn:
allOf:
- $ref: "#/components/schemas/arnType"
- description: The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
PolicyInputList: allOf: - $ref: "#/components/schemas/SimulationPolicyListType" - description:An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
iam:CreateUser.
ResourceArns:
allOf:
- $ref: "#/components/schemas/ResourceNameListType"
- description: A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Simulation of resource-based policies isn't supported for IAM roles.
ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.
CallerArn:
allOf:
- $ref: "#/components/schemas/ResourceNameType"
- description: The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.
You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
ContextEntries: allOf: - $ref: "#/components/schemas/ContextEntryListType" - description: A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied. ResourceHandlingOption: allOf: - $ref: "#/components/schemas/ResourceHandlingOptionType" - description:Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.
Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
EC2-VPC-InstanceStore
instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet
instance, image, security group, network interface, subnet
EC2-VPC-EBS
instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet
instance, image, security group, network interface, subnet, volume
Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.
If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
Marker element in the response that you received to indicate where the next call should start.
Statement:
type: object
properties:
SourcePolicyId:
allOf:
- $ref: "#/components/schemas/PolicyIdentifierType"
- description: The identifier of the policy that was provided as an input.
SourcePolicyType:
allOf:
- $ref: "#/components/schemas/PolicySourceType"
- description: The type of the policy.
StartPosition:
allOf:
- $ref: "#/components/schemas/Position"
- description: The row and column of the beginning of the Statement in an IAM policy.
EndPosition:
allOf:
- $ref: "#/components/schemas/Position"
- description: The row and column of the end of a Statement in an IAM policy.
description: Contains a reference to a Statement element in a policy document that determines the result of the simulation.
This data type is used by the MatchedStatements member of the EvaluationResult type.
The name of the IAM instance profile to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM instance profile. Each tag consists of a key name and an associated value. TagMFADeviceRequest: type: object required: - SerialNumber - Tags title: TagMFADeviceRequest properties: SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'The unique identifier for the IAM virtual MFA device to which you want to add tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM virtual MFA device. Each tag consists of a key name and an associated value. TagOpenIDConnectProviderRequest: type: object required: - OpenIDConnectProviderArn - Tags title: TagOpenIDConnectProviderRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the OIDC identity provider in IAM to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value. TagPolicyRequest: type: object required: - PolicyArn - Tags title: TagPolicyRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the IAM customer managed policy to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value. TagRoleRequest: type: object required: - RoleName - Tags title: TagRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the IAM role to which you want to add tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value. TagSAMLProviderRequest: type: object required: - SAMLProviderArn - Tags title: TagSAMLProviderRequest properties: SAMLProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the SAML identity provider in IAM to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the SAML identity provider in IAM. Each tag consists of a key name and an associated value. TagServerCertificateRequest: type: object required: - ServerCertificateName - Tags title: TagServerCertificateRequest properties: ServerCertificateName: allOf: - $ref: "#/components/schemas/serverCertificateNameType" - description: 'The name of the IAM server certificate to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM server certificate. Each tag consists of a key name and an associated value. TagUserRequest: type: object required: - UserName - Tags title: TagUserRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the IAM user to which you want to add tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value. TrackedActionLastAccessed: type: object properties: ActionName: allOf: - $ref: "#/components/schemas/stringType" - description: The name of the tracked action to which access was attempted. Tracked actions are actions that report activity to IAM. LastAccessedEntity: $ref: "#/components/schemas/arnType" LastAccessedTime: allOf: - $ref: "#/components/schemas/dateType" - description:The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the tracked service. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
LastAccessedRegion: allOf: - $ref: "#/components/schemas/stringType" - description:The Region from which the authenticated entity (user or role) last attempted to access the tracked action. Amazon Web Services does not report unauthenticated requests.
This field is null if no IAM entities attempted to access the service within the tracking period.
description:Contains details about the most recent attempt to access an action within the service.
This data type is used as a response element in the GetServiceLastAccessedDetails operation.
tagKeyListType: type: array items: $ref: "#/components/schemas/tagKeyType" maxItems: 50 UntagInstanceProfileRequest: type: object required: - InstanceProfileName - TagKeys title: UntagInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: "#/components/schemas/instanceProfileNameType" - description: 'The name of the IAM instance profile from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile. UntagMFADeviceRequest: type: object required: - SerialNumber - TagKeys title: UntagMFADeviceRequest properties: SerialNumber: allOf: - $ref: "#/components/schemas/serialNumberType" - description: 'The unique identifier for the IAM virtual MFA device from which you want to remove tags. For virtual MFA devices, the serial number is the same as the ARN.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified instance profile. UntagOpenIDConnectProviderRequest: type: object required: - OpenIDConnectProviderArn - TagKeys title: UntagOpenIDConnectProviderRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the OIDC provider in IAM from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified OIDC provider. UntagPolicyRequest: type: object required: - PolicyArn - TagKeys title: UntagPolicyRequest properties: PolicyArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the IAM customer managed policy from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy. UntagRoleRequest: type: object required: - RoleName - TagKeys title: UntagRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: 'The name of the IAM role from which you want to remove tags.
This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role. UntagSAMLProviderRequest: type: object required: - SAMLProviderArn - TagKeys title: UntagSAMLProviderRequest properties: SAMLProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description: 'The ARN of the SAML identity provider in IAM from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified SAML identity provider. UntagServerCertificateRequest: type: object required: - ServerCertificateName - TagKeys title: UntagServerCertificateRequest properties: ServerCertificateName: allOf: - $ref: "#/components/schemas/serverCertificateNameType" - description: 'The name of the IAM server certificate from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified IAM server certificate. UntagUserRequest: type: object required: - UserName - TagKeys title: UntagUserRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the IAM user from which you want to remove tags.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' TagKeys: allOf: - $ref: "#/components/schemas/tagKeyListType" - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user. UpdateAccessKeyRequest: type: object required: - AccessKeyId - Status title: UpdateAccessKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the user whose key you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' AccessKeyId: allOf: - $ref: "#/components/schemas/accessKeyIdType" - description:The access key ID of the secret access key you want to update.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Status: allOf: - $ref: "#/components/schemas/statusType" - description: " The status you want to assign to the secret access key.Active means that the key can be used for programmatic calls to Amazon Web Services, while Inactive means that the key cannot be used."
UpdateAccountPasswordPolicyRequest:
type: object
title: UpdateAccountPasswordPolicyRequest
properties:
MinimumPasswordLength:
allOf:
- $ref: "#/components/schemas/minimumPasswordLengthType"
- description: The minimum number of characters allowed in an IAM user password.
If you do not specify a value for this parameter, then the operation uses the default value of 6.
Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.
Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.
Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.
Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.
Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide.
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.
The number of days that an IAM user password is valid.
If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.
Specifies the number of previous passwords that IAM users are prevented from reusing.
If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.
Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password.
If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.
In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
The name of the role to update with the new policy.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' PolicyDocument: allOf: - $ref: "#/components/schemas/policyDocumentType" - description:The policy that grants an entity permission to assume the role.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Name of the IAM group to update. If you're changing the name of the group, this is the original name.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" NewPath: allOf: - $ref: "#/components/schemas/pathType" - description:New path for the IAM group. Only include this if changing the group's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
New name for the IAM group. Only include this if changing the group's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
UpdateLoginProfileRequest: type: object required: - UserName title: UpdateLoginProfileRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the user whose password you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' Password: allOf: - $ref: "#/components/schemas/passwordType" - description:The new password for the specified IAM user.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.
PasswordResetRequired: allOf: - $ref: "#/components/schemas/booleanObjectType" - description: Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in. UpdateOpenIDConnectProviderThumbprintRequest: type: object required: - OpenIDConnectProviderArn - ThumbprintList title: UpdateOpenIDConnectProviderThumbprintRequest properties: OpenIDConnectProviderArn: allOf: - $ref: "#/components/schemas/arnType" - description:The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
ThumbprintList: allOf: - $ref: "#/components/schemas/thumbprintListType" - description: "A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. " UpdateRoleDescriptionRequest: type: object required: - RoleName - Description title: UpdateRoleDescriptionRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The name of the role that you want to modify. Description: allOf: - $ref: "#/components/schemas/roleDescriptionType" - description: The new description that you want to apply to the specified role. UpdateRoleRequest: type: object required: - RoleName title: UpdateRoleRequest properties: RoleName: allOf: - $ref: "#/components/schemas/roleNameType" - description: The name of the role that you want to modify. Description: allOf: - $ref: "#/components/schemas/roleDescriptionType" - description: The new description that you want to apply to the specified role. MaxSessionDuration: allOf: - $ref: "#/components/schemas/roleMaxSessionDurationType" - description:The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
UpdateSSHPublicKeyRequest: type: object required: - UserName - SSHPublicKeyId - Status title: UpdateSSHPublicKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SSHPublicKeyId: allOf: - $ref: "#/components/schemas/publicKeyIdType" - description:The unique identifier for the SSH public key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status to assign to the SSH public key.Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
UpdateServerCertificateRequest:
type: object
required:
- ServerCertificateName
title: UpdateServerCertificateRequest
properties:
ServerCertificateName:
allOf:
- $ref: "#/components/schemas/serverCertificateNameType"
- description: 'The name of the server certificate that you want to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' NewPath: allOf: - $ref: "#/components/schemas/pathType" - description:The new path for the server certificate. Include this only if you are updating the server certificate's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" UpdateServiceSpecificCredentialRequest: type: object required: - ServiceSpecificCredentialId - Status title: UpdateServiceSpecificCredentialRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' ServiceSpecificCredentialId: allOf: - $ref: "#/components/schemas/serviceSpecificCredentialId" - description:The unique identifier of the service-specific credential.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Status: allOf: - $ref: "#/components/schemas/statusType" - description: The status to be assigned to the service-specific credential. UpdateSigningCertificateRequest: type: object required: - CertificateId - Status title: UpdateSigningCertificateRequest properties: UserName: allOf: - $ref: "#/components/schemas/existingUserNameType" - description: 'The name of the IAM user the signing certificate belongs to.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' CertificateId: allOf: - $ref: "#/components/schemas/certificateIdType" - description:The ID of the signing certificate you want to update.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
Status: allOf: - $ref: "#/components/schemas/statusType" - description: " The status you want to assign to the certificate.Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used."
UpdateUserRequest:
type: object
required:
- UserName
title: UpdateUserRequest
properties:
UserName:
allOf:
- $ref: "#/components/schemas/existingUserNameType"
- description: "Name of the user to update. If you're changing the name of the user, this is the original user name.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
" NewPath: allOf: - $ref: "#/components/schemas/pathType" - description:New path for the IAM user. Include this parameter only if you're changing the user's path.
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
New name for the user. Include this parameter only if you're changing the user's name.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
UploadSSHPublicKeyRequest: type: object required: - UserName - SSHPublicKeyBody title: UploadSSHPublicKeyRequest properties: UserName: allOf: - $ref: "#/components/schemas/userNameType" - description: 'The name of the IAM user to associate the SSH public key with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' SSHPublicKeyBody: allOf: - $ref: "#/components/schemas/publicKeyMaterialType" - description:The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).
The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' CertificateBody: allOf: - $ref: "#/components/schemas/certificateBodyType" - description:The contents of the public key certificate in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The contents of the private key in PEM-encoded format.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
The name of the user the signing certificate is for.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' CertificateBody: allOf: - $ref: "#/components/schemas/certificateBodyType" - description:The contents of the signing certificate.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
The ARN of the policy used to set the permissions boundary for the user.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Tags: allOf: - $ref: "#/components/schemas/tagListType" - description: A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description:Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
summaryKeyType: type: string enum: - Users - UsersQuota - Groups - GroupsQuota - ServerCertificates - ServerCertificatesQuota - UserPolicySizeQuota - GroupPolicySizeQuota - GroupsPerUserQuota - SigningCertificatesPerUserQuota - AccessKeysPerUserQuota - MFADevices - MFADevicesInUse - AccountMFAEnabled - AccountAccessKeysPresent - AccountSigningCertificatesPresent - AttachedPoliciesPerGroupQuota - AttachedPoliciesPerRoleQuota - AttachedPoliciesPerUserQuota - Policies - PoliciesQuota - PolicySizeQuota - PolicyVersionsInUse - PolicyVersionsInUseQuota - VersionsPerPolicyQuota - GlobalEndpointTokenVersion summaryValueType: type: integer security: - hmac: []