{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.iam#AWSIdentityManagementV20100508": {
"type": "service",
"version": "2010-05-08",
"operations": [
{
"target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#AddRoleToInstanceProfile"
},
{
"target": "com.amazonaws.iam#AddUserToGroup"
},
{
"target": "com.amazonaws.iam#AttachGroupPolicy"
},
{
"target": "com.amazonaws.iam#AttachRolePolicy"
},
{
"target": "com.amazonaws.iam#AttachUserPolicy"
},
{
"target": "com.amazonaws.iam#ChangePassword"
},
{
"target": "com.amazonaws.iam#CreateAccessKey"
},
{
"target": "com.amazonaws.iam#CreateAccountAlias"
},
{
"target": "com.amazonaws.iam#CreateGroup"
},
{
"target": "com.amazonaws.iam#CreateInstanceProfile"
},
{
"target": "com.amazonaws.iam#CreateLoginProfile"
},
{
"target": "com.amazonaws.iam#CreateOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#CreatePolicy"
},
{
"target": "com.amazonaws.iam#CreatePolicyVersion"
},
{
"target": "com.amazonaws.iam#CreateRole"
},
{
"target": "com.amazonaws.iam#CreateSAMLProvider"
},
{
"target": "com.amazonaws.iam#CreateServiceLinkedRole"
},
{
"target": "com.amazonaws.iam#CreateServiceSpecificCredential"
},
{
"target": "com.amazonaws.iam#CreateUser"
},
{
"target": "com.amazonaws.iam#CreateVirtualMFADevice"
},
{
"target": "com.amazonaws.iam#DeactivateMFADevice"
},
{
"target": "com.amazonaws.iam#DeleteAccessKey"
},
{
"target": "com.amazonaws.iam#DeleteAccountAlias"
},
{
"target": "com.amazonaws.iam#DeleteAccountPasswordPolicy"
},
{
"target": "com.amazonaws.iam#DeleteGroup"
},
{
"target": "com.amazonaws.iam#DeleteGroupPolicy"
},
{
"target": "com.amazonaws.iam#DeleteInstanceProfile"
},
{
"target": "com.amazonaws.iam#DeleteLoginProfile"
},
{
"target": "com.amazonaws.iam#DeleteOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#DeletePolicy"
},
{
"target": "com.amazonaws.iam#DeletePolicyVersion"
},
{
"target": "com.amazonaws.iam#DeleteRole"
},
{
"target": "com.amazonaws.iam#DeleteRolePermissionsBoundary"
},
{
"target": "com.amazonaws.iam#DeleteRolePolicy"
},
{
"target": "com.amazonaws.iam#DeleteSAMLProvider"
},
{
"target": "com.amazonaws.iam#DeleteServerCertificate"
},
{
"target": "com.amazonaws.iam#DeleteServiceLinkedRole"
},
{
"target": "com.amazonaws.iam#DeleteServiceSpecificCredential"
},
{
"target": "com.amazonaws.iam#DeleteSigningCertificate"
},
{
"target": "com.amazonaws.iam#DeleteSSHPublicKey"
},
{
"target": "com.amazonaws.iam#DeleteUser"
},
{
"target": "com.amazonaws.iam#DeleteUserPermissionsBoundary"
},
{
"target": "com.amazonaws.iam#DeleteUserPolicy"
},
{
"target": "com.amazonaws.iam#DeleteVirtualMFADevice"
},
{
"target": "com.amazonaws.iam#DetachGroupPolicy"
},
{
"target": "com.amazonaws.iam#DetachRolePolicy"
},
{
"target": "com.amazonaws.iam#DetachUserPolicy"
},
{
"target": "com.amazonaws.iam#EnableMFADevice"
},
{
"target": "com.amazonaws.iam#GenerateCredentialReport"
},
{
"target": "com.amazonaws.iam#GenerateOrganizationsAccessReport"
},
{
"target": "com.amazonaws.iam#GenerateServiceLastAccessedDetails"
},
{
"target": "com.amazonaws.iam#GetAccessKeyLastUsed"
},
{
"target": "com.amazonaws.iam#GetAccountAuthorizationDetails"
},
{
"target": "com.amazonaws.iam#GetAccountPasswordPolicy"
},
{
"target": "com.amazonaws.iam#GetAccountSummary"
},
{
"target": "com.amazonaws.iam#GetContextKeysForCustomPolicy"
},
{
"target": "com.amazonaws.iam#GetContextKeysForPrincipalPolicy"
},
{
"target": "com.amazonaws.iam#GetCredentialReport"
},
{
"target": "com.amazonaws.iam#GetGroup"
},
{
"target": "com.amazonaws.iam#GetGroupPolicy"
},
{
"target": "com.amazonaws.iam#GetInstanceProfile"
},
{
"target": "com.amazonaws.iam#GetLoginProfile"
},
{
"target": "com.amazonaws.iam#GetOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#GetOrganizationsAccessReport"
},
{
"target": "com.amazonaws.iam#GetPolicy"
},
{
"target": "com.amazonaws.iam#GetPolicyVersion"
},
{
"target": "com.amazonaws.iam#GetRole"
},
{
"target": "com.amazonaws.iam#GetRolePolicy"
},
{
"target": "com.amazonaws.iam#GetSAMLProvider"
},
{
"target": "com.amazonaws.iam#GetServerCertificate"
},
{
"target": "com.amazonaws.iam#GetServiceLastAccessedDetails"
},
{
"target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntities"
},
{
"target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatus"
},
{
"target": "com.amazonaws.iam#GetSSHPublicKey"
},
{
"target": "com.amazonaws.iam#GetUser"
},
{
"target": "com.amazonaws.iam#GetUserPolicy"
},
{
"target": "com.amazonaws.iam#ListAccessKeys"
},
{
"target": "com.amazonaws.iam#ListAccountAliases"
},
{
"target": "com.amazonaws.iam#ListAttachedGroupPolicies"
},
{
"target": "com.amazonaws.iam#ListAttachedRolePolicies"
},
{
"target": "com.amazonaws.iam#ListAttachedUserPolicies"
},
{
"target": "com.amazonaws.iam#ListEntitiesForPolicy"
},
{
"target": "com.amazonaws.iam#ListGroupPolicies"
},
{
"target": "com.amazonaws.iam#ListGroups"
},
{
"target": "com.amazonaws.iam#ListGroupsForUser"
},
{
"target": "com.amazonaws.iam#ListInstanceProfiles"
},
{
"target": "com.amazonaws.iam#ListInstanceProfilesForRole"
},
{
"target": "com.amazonaws.iam#ListInstanceProfileTags"
},
{
"target": "com.amazonaws.iam#ListMFADevices"
},
{
"target": "com.amazonaws.iam#ListMFADeviceTags"
},
{
"target": "com.amazonaws.iam#ListOpenIDConnectProviders"
},
{
"target": "com.amazonaws.iam#ListOpenIDConnectProviderTags"
},
{
"target": "com.amazonaws.iam#ListPolicies"
},
{
"target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccess"
},
{
"target": "com.amazonaws.iam#ListPolicyTags"
},
{
"target": "com.amazonaws.iam#ListPolicyVersions"
},
{
"target": "com.amazonaws.iam#ListRolePolicies"
},
{
"target": "com.amazonaws.iam#ListRoles"
},
{
"target": "com.amazonaws.iam#ListRoleTags"
},
{
"target": "com.amazonaws.iam#ListSAMLProviders"
},
{
"target": "com.amazonaws.iam#ListSAMLProviderTags"
},
{
"target": "com.amazonaws.iam#ListServerCertificates"
},
{
"target": "com.amazonaws.iam#ListServerCertificateTags"
},
{
"target": "com.amazonaws.iam#ListServiceSpecificCredentials"
},
{
"target": "com.amazonaws.iam#ListSigningCertificates"
},
{
"target": "com.amazonaws.iam#ListSSHPublicKeys"
},
{
"target": "com.amazonaws.iam#ListUserPolicies"
},
{
"target": "com.amazonaws.iam#ListUsers"
},
{
"target": "com.amazonaws.iam#ListUserTags"
},
{
"target": "com.amazonaws.iam#ListVirtualMFADevices"
},
{
"target": "com.amazonaws.iam#PutGroupPolicy"
},
{
"target": "com.amazonaws.iam#PutRolePermissionsBoundary"
},
{
"target": "com.amazonaws.iam#PutRolePolicy"
},
{
"target": "com.amazonaws.iam#PutUserPermissionsBoundary"
},
{
"target": "com.amazonaws.iam#PutUserPolicy"
},
{
"target": "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#RemoveRoleFromInstanceProfile"
},
{
"target": "com.amazonaws.iam#RemoveUserFromGroup"
},
{
"target": "com.amazonaws.iam#ResetServiceSpecificCredential"
},
{
"target": "com.amazonaws.iam#ResyncMFADevice"
},
{
"target": "com.amazonaws.iam#SetDefaultPolicyVersion"
},
{
"target": "com.amazonaws.iam#SetSecurityTokenServicePreferences"
},
{
"target": "com.amazonaws.iam#SimulateCustomPolicy"
},
{
"target": "com.amazonaws.iam#SimulatePrincipalPolicy"
},
{
"target": "com.amazonaws.iam#TagInstanceProfile"
},
{
"target": "com.amazonaws.iam#TagMFADevice"
},
{
"target": "com.amazonaws.iam#TagOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#TagPolicy"
},
{
"target": "com.amazonaws.iam#TagRole"
},
{
"target": "com.amazonaws.iam#TagSAMLProvider"
},
{
"target": "com.amazonaws.iam#TagServerCertificate"
},
{
"target": "com.amazonaws.iam#TagUser"
},
{
"target": "com.amazonaws.iam#UntagInstanceProfile"
},
{
"target": "com.amazonaws.iam#UntagMFADevice"
},
{
"target": "com.amazonaws.iam#UntagOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#UntagPolicy"
},
{
"target": "com.amazonaws.iam#UntagRole"
},
{
"target": "com.amazonaws.iam#UntagSAMLProvider"
},
{
"target": "com.amazonaws.iam#UntagServerCertificate"
},
{
"target": "com.amazonaws.iam#UntagUser"
},
{
"target": "com.amazonaws.iam#UpdateAccessKey"
},
{
"target": "com.amazonaws.iam#UpdateAccountPasswordPolicy"
},
{
"target": "com.amazonaws.iam#UpdateAssumeRolePolicy"
},
{
"target": "com.amazonaws.iam#UpdateGroup"
},
{
"target": "com.amazonaws.iam#UpdateLoginProfile"
},
{
"target": "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprint"
},
{
"target": "com.amazonaws.iam#UpdateRole"
},
{
"target": "com.amazonaws.iam#UpdateRoleDescription"
},
{
"target": "com.amazonaws.iam#UpdateSAMLProvider"
},
{
"target": "com.amazonaws.iam#UpdateServerCertificate"
},
{
"target": "com.amazonaws.iam#UpdateServiceSpecificCredential"
},
{
"target": "com.amazonaws.iam#UpdateSigningCertificate"
},
{
"target": "com.amazonaws.iam#UpdateSSHPublicKey"
},
{
"target": "com.amazonaws.iam#UpdateUser"
},
{
"target": "com.amazonaws.iam#UploadServerCertificate"
},
{
"target": "com.amazonaws.iam#UploadSigningCertificate"
},
{
"target": "com.amazonaws.iam#UploadSSHPublicKey"
}
],
"traits": {
"aws.api#service": {
"sdkId": "IAM",
"arnNamespace": "iam",
"cloudFormationName": "IAM",
"cloudTrailEventSource": "iam.amazonaws.com",
"endpointPrefix": "iam"
},
"aws.auth#sigv4": {
"name": "iam"
},
"aws.protocols#awsQuery": {},
"smithy.api#documentation": "
AWS Identity and Access Management (IAM) is a web service for securely controlling \n access to AWS services. With IAM, you can centrally manage users, security credentials\n such as access keys, and permissions that control which AWS resources users and \n applications can access. For more information about IAM, see AWS Identity and Access Management (IAM) and the AWS Identity and Access Management User Guide.
", "smithy.api#title": "AWS Identity and Access Management", "smithy.api#xmlNamespace": { "uri": "https://iam.amazonaws.com/doc/2010-05-08/" } } }, "com.amazonaws.iam#AccessAdvisorUsageGranularityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SERVICE_LEVEL", "name": "SERVICE_LEVEL" }, { "value": "ACTION_LEVEL", "name": "ACTION_LEVEL" } ] } }, "com.amazonaws.iam#AccessDetail": { "type": "structure", "members": { "ServiceName": { "target": "com.amazonaws.iam#serviceNameType", "traits": { "smithy.api#documentation": "The name of the service in which access was attempted.
", "smithy.api#required": {} } }, "ServiceNamespace": { "target": "com.amazonaws.iam#serviceNamespaceType", "traits": { "smithy.api#documentation": "The namespace of the service in which access was attempted.
\nTo learn the service namespace of a service, see Actions, resources, and condition keys for AWS services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b)
. For more information about service namespaces,\n see AWS\n service namespaces in the AWS General Reference.
The Region where the last service access attempt occurred.
\nThis field is null if no principals in the reported Organizations entity attempted to access the\n service within the reporting period.
" } }, "EntityPath": { "target": "com.amazonaws.iam#organizationsEntityPathType", "traits": { "smithy.api#documentation": "The path of the Organizations entity (root, organizational unit, or account) from which an\n authenticated principal last attempted to access the service. AWS does not report\n unauthenticated requests.
\nThis field is null if no principals (IAM users, IAM roles, or root users) in the\n reported Organizations entity attempted to access the service within the reporting period.
" } }, "LastAuthenticatedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when an authenticated principal most recently attempted to access the\n service. AWS does not report unauthenticated requests.
\nThis field is null if no principals in the reported Organizations entity attempted to access the\n service within the reporting period.
" } }, "TotalAuthenticatedEntities": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The number of accounts with authenticated principals (root users, IAM users, and IAM\n roles) that attempted to access the service in the reporting period.
" } } }, "traits": { "smithy.api#documentation": "An object that contains details about when a principal in the reported AWS Organizations entity\n last attempted to access an AWS service. A principal can be an IAM user, an IAM role,\n or the AWS account root user within the reported Organizations entity.
\nThis data type is a response element in the GetOrganizationsAccessReport operation.
" } }, "com.amazonaws.iam#AccessDetails": { "type": "list", "member": { "target": "com.amazonaws.iam#AccessDetail" } }, "com.amazonaws.iam#AccessKey": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user that the access key is associated with.
", "smithy.api#required": {} } }, "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "The ID for this access key.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the access key. Active
means that the key is valid for API\n calls, while Inactive
means it is not.
The secret key used to sign requests.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date when the access key was created.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an AWS access key.
\nThis data type is used as a response element in the CreateAccessKey\n and ListAccessKeys operations.
\nThe SecretAccessKey
value is returned only in response to CreateAccessKey. You can get a secret access key only when you first\n create an access key; you cannot recover the secret access key later. If you lose a\n secret access key, you must create a new access key.
The date and time, in ISO 8601 date-time\n format, when the access key was most recently used. This field is null in the\n following situations:
\nThe user does not have an access key.
\nAn access key exists but has not been used since IAM began tracking this\n information.
\nThere is no sign-in data associated with the user.
\nThe name of the AWS service with which this access key was most recently used. The value\n of this field is \"N/A\" in the following situations:
\nThe user does not have an access key.
\nAn access key exists but has not been used since IAM started tracking this\n information.
\nThere is no sign-in data associated with the user.
\nThe AWS Region where this access key was most recently used. The value for this field is\n \"N/A\" in the following situations:
\nThe user does not have an access key.
\nAn access key exists but has not been used since IAM began tracking this\n information.
\nThere is no sign-in data associated with the user.
\nFor more information about AWS Regions, see Regions and endpoints in the Amazon Web Services\n General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the last time an AWS access key was used since IAM began\n tracking this information on April 22, 2015.
\nThis data type is used as a response element in the GetAccessKeyLastUsed operation.
" } }, "com.amazonaws.iam#AccessKeyMetadata": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user that the key is associated with.
" } }, "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "The ID for this access key.
" } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the access key. Active
means that the key is valid for API\n calls; Inactive
means it is not.
The date when the access key was created.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an AWS access key, without its secret key.
\nThis data type is used as a response element in the ListAccessKeys\n operation.
" } }, "com.amazonaws.iam#ActionNameListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ActionNameType" } }, "com.amazonaws.iam#ActionNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 128 } } }, "com.amazonaws.iam#AddClientIDToOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds a new client ID (also known as audience) to the list of client IDs already\n registered for the specified IAM OpenID Connect (OIDC) provider resource.
\nThis operation is idempotent; it does not fail or return an error if you add an\n existing client ID to the provider.
" } }, "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to\n add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
", "smithy.api#required": {} } }, "ClientID": { "target": "com.amazonaws.iam#clientIDType", "traits": { "smithy.api#documentation": "The client ID (also known as audience) to add to the IAM OpenID Connect provider\n resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#AddRoleToInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#AddRoleToInstanceProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Adds the specified IAM role to the specified instance profile. An instance profile\n can contain only one role, and this quota cannot be increased. You can remove the\n existing role and then add a different role to an instance profile. You must then wait\n for the change to appear across all of AWS because of eventual\n consistency. To force the change, you must disassociate the instance profile and then associate the\n instance profile, or you can stop your instance and then restart it.
\nThe caller of this operation must be granted the PassRole
permission\n on the IAM role by a permissions policy.
For more information about roles, see Working with roles. For more\n information about instance profiles, see About instance\n profiles.
" } }, "com.amazonaws.iam#AddRoleToInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the instance profile to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role to add.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#AddUserToGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#AddUserToGroupRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds the specified user to the specified group.
" } }, "com.amazonaws.iam#AddUserToGroupRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name of the group to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user to add.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#ArnListType": { "type": "list", "member": { "target": "com.amazonaws.iam#arnType" } }, "com.amazonaws.iam#AttachGroupPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachGroupPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PolicyNotAttachableException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Attaches the specified managed policy to the specified IAM group.
\nYou use this operation to attach a managed policy to a group. To embed an inline\n policy in a group, use PutGroupPolicy.
\nAs a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#AttachGroupPolicyRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the group to attach the policy to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#AttachRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachRolePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PolicyNotAttachableException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Attaches the specified managed policy to the specified IAM role. When you attach a\n managed policy to a role, the managed policy becomes part of the role's permission\n (access) policy.
\nYou cannot use a managed policy as the role's trust policy. The role's trust\n policy is created at the same time as the role, using CreateRole.\n You can update a role's trust policy using UpdateAssumeRolePolicy.
\nUse this operation to attach a managed policy to a role. To embed\n an inline policy in a role, use PutRolePolicy. For more information\n about policies, see Managed policies and inline\n policies in the IAM User Guide.
\nAs a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.
" } }, "com.amazonaws.iam#AttachRolePolicyRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the role to attach the policy to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#AttachUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachUserPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PolicyNotAttachableException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Attaches the specified managed policy to the specified user.
\nYou use this operation to attach a managed policy to a user. To\n embed an inline policy in a user, use PutUserPolicy.
\nAs a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#AttachUserPolicyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the IAM user to attach the policy to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#AttachedPermissionsBoundary": { "type": "structure", "members": { "PermissionsBoundaryType": { "target": "com.amazonaws.iam#PermissionsBoundaryAttachmentType", "traits": { "smithy.api#documentation": " The permissions boundary usage type that indicates what type of IAM resource is used\n as the permissions boundary for an entity. This data type can only have a value of\n Policy
.
The ARN of the policy used to set the permissions boundary for the user or role.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an attached permissions boundary.
\nAn attached permissions boundary is a managed policy that has been attached to a user or\n role to set the permissions boundary.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "com.amazonaws.iam#AttachedPolicy": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The friendly name of the attached policy.
" } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType" } }, "traits": { "smithy.api#documentation": "Contains information about an attached policy.
\nAn attached policy is a managed policy that has been attached to a user, group, or role.\n This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#BootstrapDatum": { "type": "blob", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.iam#ChangePassword": { "type": "operation", "input": { "target": "com.amazonaws.iam#ChangePasswordRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#InvalidUserTypeException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PasswordPolicyViolationException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Changes the password of the IAM user who is calling this operation. This operation\n can be performed using the AWS CLI, the AWS API, or the My\n Security Credentials page in the AWS Management Console. The AWS account root user\n password is not affected by this operation.
\nUse UpdateLoginProfile to use the AWS CLI, the AWS API, or the\n Users page in the IAM console to change the\n password for any IAM user. For more information about modifying passwords, see Managing\n passwords in the IAM User Guide.
" } }, "com.amazonaws.iam#ChangePasswordRequest": { "type": "structure", "members": { "OldPassword": { "target": "com.amazonaws.iam#passwordType", "traits": { "smithy.api#documentation": "The IAM user's current password.
", "smithy.api#required": {} } }, "NewPassword": { "target": "com.amazonaws.iam#passwordType", "traits": { "smithy.api#documentation": "The new password. The new password must conform to the AWS account's password\n policy, if one exists.
\nThe regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020
) through the end of the ASCII character range (\\u00FF
). \n You can also include the tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the AWS Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.
The request was rejected because multiple requests to change this object were submitted\n simultaneously. Wait a few minutes and submit your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#ConcurrentModificationMessage": { "type": "string" }, "com.amazonaws.iam#ContextEntry": { "type": "structure", "members": { "ContextKeyName": { "target": "com.amazonaws.iam#ContextKeyNameType", "traits": { "smithy.api#documentation": "The full name of a condition context key, including the service prefix. For example,\n aws:SourceIp
or s3:VersionId
.
The value (or values, if the condition context key supports multiple values) to provide\n to the simulation when the key is referenced by a Condition
element in an\n input policy.
The data type of the value (or values) specified in the ContextKeyValues
\n parameter.
Contains information about a condition context key. It includes the name of the key and\n specifies the value (or values, if the context key supports multiple values) to use in the\n simulation. This information is used when evaluating the Condition
elements of\n the input policies.
This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.
" } }, "com.amazonaws.iam#ContextEntryListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ContextEntry" } }, "com.amazonaws.iam#ContextKeyNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 256 } } }, "com.amazonaws.iam#ContextKeyNamesResultListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ContextKeyNameType" } }, "com.amazonaws.iam#ContextKeyTypeEnum": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "string", "name": "STRING" }, { "value": "stringList", "name": "STRING_LIST" }, { "value": "numeric", "name": "NUMERIC" }, { "value": "numericList", "name": "NUMERIC_LIST" }, { "value": "boolean", "name": "BOOLEAN" }, { "value": "booleanList", "name": "BOOLEAN_LIST" }, { "value": "ip", "name": "IP" }, { "value": "ipList", "name": "IP_LIST" }, { "value": "binary", "name": "BINARY" }, { "value": "binaryList", "name": "BINARY_LIST" }, { "value": "date", "name": "DATE" }, { "value": "dateList", "name": "DATE_LIST" } ] } }, "com.amazonaws.iam#ContextKeyValueListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ContextKeyValueType" } }, "com.amazonaws.iam#ContextKeyValueType": { "type": "string" }, "com.amazonaws.iam#CreateAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateAccessKeyRequest" }, "output": { "target": "com.amazonaws.iam#CreateAccessKeyResponse" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": " Creates a new AWS secret access key and corresponding AWS access key ID for the\n 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\n the AWS access key ID signing the request. This operation works for access keys under\n the AWS account. Consequently, you can use this operation to manage AWS account root\n user credentials. This is true even if the AWS account has no associated users.
\nFor information about quotas on the number of keys you can create, see IAM and STS\n quotas in the IAM User Guide.
\nTo ensure the security of your AWS account, the secret access key is accessible\n only during key and user creation. You must save the key (for example, in a text\n file) if you want to be able to access it again. If a secret key is lost, you can\n delete the access keys for the associated user and then create new keys.
\nThe name of the IAM user that the new key will belong to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } } } }, "com.amazonaws.iam#CreateAccessKeyResponse": { "type": "structure", "members": { "AccessKey": { "target": "com.amazonaws.iam#AccessKey", "traits": { "smithy.api#documentation": "A structure with details about the access key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateAccessKey request.\n
" } }, "com.amazonaws.iam#CreateAccountAlias": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateAccountAliasRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an alias for your AWS account. For information about using an AWS account\n alias, see Using an\n alias for your AWS account ID in the\n IAM User Guide.
" } }, "com.amazonaws.iam#CreateAccountAliasRequest": { "type": "structure", "members": { "AccountAlias": { "target": "com.amazonaws.iam#accountAliasType", "traits": { "smithy.api#documentation": "The account alias to create.
\nThis parameter allows (through its regex pattern) a string of characters consisting of \n lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have \n two dashes in a row.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#CreateGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateGroupRequest" }, "output": { "target": "com.amazonaws.iam#CreateGroupResponse" }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new group.
\nFor information about the number of groups you can create, see IAM and STS\n quotas in the IAM User Guide.
" } }, "com.amazonaws.iam#CreateGroupRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the group. For more information about paths, see IAM\n identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The name of the group to create. Do not include the path in this value.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#CreateGroupResponse": { "type": "structure", "members": { "Group": { "target": "com.amazonaws.iam#Group", "traits": { "smithy.api#documentation": "A structure containing details about the new group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateGroup request.
" } }, "com.amazonaws.iam#CreateInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateInstanceProfileRequest" }, "output": { "target": "com.amazonaws.iam#CreateInstanceProfileResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new instance profile. For information about instance profiles, see Using\n roles for applications on Amazon EC2 in the\n IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
\nFor information about the number of instance profiles you can create, see IAM object\n quotas in the IAM User Guide.
" } }, "com.amazonaws.iam#CreateInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the instance profile to create.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the instance profile. For more information about paths, see IAM\n Identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n 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.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nA structure containing details about the new instance profile.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateInstanceProfile request.\n
" } }, "com.amazonaws.iam#CreateLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateLoginProfileRequest" }, "output": { "target": "com.amazonaws.iam#CreateLoginProfileResponse" }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PasswordPolicyViolationException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a password for the specified IAM user. A password allows an IAM user to\n access AWS services through the AWS Management Console.
\nYou can use the AWS CLI, the AWS API, or the Users page in the IAM console to create a password for any IAM user.\n Use ChangePassword to update your own existing password in the\n My Security Credentials page in the\n AWS Management Console.
\nFor more information about managing passwords, see Managing passwords in the\n IAM User Guide.
" } }, "com.amazonaws.iam#CreateLoginProfileRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user to create a password for. The user must already\n exist.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.iam#passwordType", "traits": { "smithy.api#documentation": "The new password for the user.
\nThe regex pattern \n that is used to validate this parameter is a string of characters. That string can include almost any printable \n ASCII character from the space (\\u0020
) through the end of the ASCII character range (\\u00FF
). \n You can also include the tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
) \n characters. Any of these characters are valid in a password. However, many tools, such \n as the AWS Management Console, might restrict the ability to type certain characters because they have \n special meaning within that tool.
Specifies whether the user is required to set a new password on next sign-in.
" } } } }, "com.amazonaws.iam#CreateLoginProfileResponse": { "type": "structure", "members": { "LoginProfile": { "target": "com.amazonaws.iam#LoginProfile", "traits": { "smithy.api#documentation": "A structure containing the user name and password create date.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateLoginProfile request.\n
" } }, "com.amazonaws.iam#CreateOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateOpenIDConnectProviderRequest" }, "output": { "target": "com.amazonaws.iam#CreateOpenIDConnectProviderResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
\nThe OIDC provider that you create with this operation can be used as a principal in a\n role's trust policy. Such a policy establishes a trust relationship between AWS and\n the OIDC provider.
\nIf you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito,\n you don't need to create a separate IAM identity provider. These OIDC identity\n providers are already built-in to AWS and are available for your use. Instead, you can\n move directly to creating new roles using your identity provider. To learn more, see\n Creating a role for web identity or OpenID connect federation in the\n IAM User Guide.
\nWhen you create the IAM OIDC provider, you specify the following:
\nThe URL of the OIDC identity provider (IdP) to trust
\nA list of client IDs (also known as audiences) that identify the application\n or applications that are allowed to authenticate using the OIDC provider
\nA list of thumbprints of one or more server certificates that the IdP\n uses
\nYou get all of this information from the OIDC IdP that you want to use to access\n AWS.
\nThe trust for the OIDC provider is derived from the IAM provider that this\n operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged\n users.
\nThe URL of the identity provider. The URL must begin with https://
and\n should correspond to the iss
claim in the provider's OpenID Connect ID\n tokens. Per the OIDC standard, path components are allowed but query parameters are not.\n Typically the URL consists of only a hostname, like\n https://server.example.org
or https://example.com
.
You cannot register the same provider multiple times in a single AWS account. If you\n try to submit a URL that has already been used for an OpenID Connect provider in the\n AWS account, you will get an error.
", "smithy.api#required": {} } }, "ClientIDList": { "target": "com.amazonaws.iam#clientIDListType", "traits": { "smithy.api#documentation": "A list of client IDs (also known as audiences). When a mobile or web app registers\n with an OpenID Connect provider, they establish a value that identifies the application.\n (This is the value that's sent as the client_id
parameter on OAuth\n requests.)
You can register multiple client IDs with the same provider. For example, you might\n have multiple applications that use the same OIDC provider. You cannot register more\n than 100 client IDs with a single IAM OIDC provider.
\nThere is no defined format for a client ID. The\n CreateOpenIDConnectProviderRequest
operation accepts client IDs up to\n 255 characters long.
A list of server certificate thumbprints for the OpenID Connect (OIDC) identity\n provider's server certificates. Typically this list includes only one entry. However,\n IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain\n multiple thumbprints if the identity provider is rotating certificates.
\nThe server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509\n certificate used by the domain where the OpenID Connect provider makes its keys\n available. It is always a 40-character string.
\nYou must provide at least one thumbprint when creating an IAM OIDC provider. For\n example, assume that the OIDC provider is server.example.com
and the\n provider stores its keys at https://keys.server.example.com/openid-connect. In that\n case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate\n used by https://keys.server.example.com.
For more information about obtaining the OIDC provider's thumbprint, see Obtaining the\n thumbprint for an OpenID Connect provider in the IAM User\n Guide.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) provider.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nThe Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is\n created. For more information, see OpenIDConnectProviderListEntry.\n
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the new IAM OIDC provider. The returned list of\n tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateOpenIDConnectProvider\n request.
" } }, "com.amazonaws.iam#CreatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreatePolicyRequest" }, "output": { "target": "com.amazonaws.iam#CreatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new managed policy for your AWS account.
\nThis operation creates a policy version with a version identifier of v1
\n and sets v1 as the policy's default version. For more information about policy versions,\n see Versioning for managed policies in the\n IAM User Guide.
As a best practice, you can validate your IAM policies. \n To learn more, see Validating IAM policies \n in the IAM User Guide.
\nFor more information about managed policies in general, see Managed\n policies and inline policies in the\n IAM User Guide.
" } }, "com.amazonaws.iam#CreatePolicyRequest": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The friendly name of the policy.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
", "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path for the policy.
\nFor more information about paths, see IAM identifiers in the\n IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The JSON policy document that you want to use as the content for the new\n policy.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
A friendly description of the policy.
\nTypically used to store information about the permissions defined in the policy. For\n example, \"Grants access to production DynamoDB tables.\"
\nThe policy description is immutable. After a value is assigned, it cannot be\n changed.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new IAM customer managed policy.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nA structure containing details about the new policy.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreatePolicy request.\n
" } }, "com.amazonaws.iam#CreatePolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreatePolicyVersionRequest" }, "output": { "target": "com.amazonaws.iam#CreatePolicyVersionResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new version of the specified managed policy. To update a managed policy, you\n create a new policy version. A managed policy can have up to five versions. If the\n policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
\nOptionally, you can set the new version as the policy's default version. The default\n version is the version that is in effect for the IAM users, groups, and roles to which\n the policy is attached.
\nFor more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#CreatePolicyVersionRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new\n version.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The JSON policy document that you want to use as the content for this new version of\n the policy.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Specifies whether to set this version as the policy's default version.
\nWhen this parameter is true
, the new policy version becomes the operative\n version. That is, it becomes the version that is in effect for the IAM users, groups,\n and roles that the policy is attached to.
For more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
" } } } }, "com.amazonaws.iam#CreatePolicyVersionResponse": { "type": "structure", "members": { "PolicyVersion": { "target": "com.amazonaws.iam#PolicyVersion", "traits": { "smithy.api#documentation": "A structure containing details about the new policy version.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreatePolicyVersion request.\n
" } }, "com.amazonaws.iam#CreateRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateRoleRequest" }, "output": { "target": "com.amazonaws.iam#CreateRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new role for your AWS account. For more information about roles, see\n IAM\n roles. For information about quotas for role names and the number of roles\n you can create, see IAM and STS quotas in the\n IAM User Guide.
" } }, "com.amazonaws.iam#CreateRoleRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the role. For more information about paths, see IAM\n Identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The name of the role to create.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
", "smithy.api#required": {} } }, "AssumeRolePolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The trust relationship policy document that grants an entity permission to assume the\n role.
\nIn IAM, you must provide a JSON policy that has been converted to a string. However,\n for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON\n or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before\n submitting it to IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Upon success, the response includes the same trust policy in JSON format.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.iam#roleDescriptionType", "traits": { "smithy.api#documentation": "A description of the role.
" } }, "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { "smithy.api#documentation": "The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default maximum of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.
\nAnyone who assumes the role from the AWS CLI or API can use the\n DurationSeconds
API parameter or the duration-seconds
CLI\n parameter to request a longer session. The MaxSessionDuration
setting\n determines the maximum duration that can be requested using the\n DurationSeconds
parameter. If users don't specify a value for the\n DurationSeconds
parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole*
API operations\n or the assume-role*
CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.
The ARN of the policy that is used to set the permissions boundary for the\n role.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nA structure containing details about the new role.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateRole request.
" } }, "com.amazonaws.iam#CreateSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateSAMLProviderRequest" }, "output": { "target": "com.amazonaws.iam#CreateSAMLProviderResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an IAM resource that describes an identity provider (IdP) that supports SAML\n 2.0.
\nThe SAML provider resource that you create with this operation can be used as a\n principal in an IAM role's trust policy. Such a policy can enable federated users who\n sign in using the SAML IdP to assume the role. You can create an IAM role that\n supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access\n to AWS.
\nWhen you create the SAML provider resource, you upload a SAML metadata document that\n you get from your IdP. That document includes the issuer's name, expiration information,\n and keys that can be used to validate the SAML authentication response (assertions) that\n the IdP sends. You must generate the metadata document using the identity management\n software that is used as your organization's IdP.
\nThis operation requires Signature Version 4.
\nFor more information, see Enabling SAML 2.0\n federated users to access the AWS Management Console and About SAML 2.0-based\n federation in the IAM User Guide.
" } }, "com.amazonaws.iam#CreateSAMLProviderRequest": { "type": "structure", "members": { "SAMLMetadataDocument": { "target": "com.amazonaws.iam#SAMLMetadataDocumentType", "traits": { "smithy.api#documentation": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The\n document includes the issuer's name, expiration information, and keys that can be used\n to validate the SAML authentication response (assertions) that are received from the\n IdP. You must generate the metadata document using the identity management software that\n is used as your organization's IdP.
\nFor more information, see About SAML 2.0-based\n federation in the IAM User Guide\n
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.iam#SAMLProviderNameType", "traits": { "smithy.api#documentation": "The name of the provider to create.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new IAM SAML provider.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nThe Amazon Resource Name (ARN) of the new SAML provider resource in IAM.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the new IAM SAML provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateSAMLProvider request.\n
" } }, "com.amazonaws.iam#CreateServiceLinkedRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateServiceLinkedRoleRequest" }, "output": { "target": "com.amazonaws.iam#CreateServiceLinkedRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an IAM role that is linked to a specific AWS service. The service controls\n the attached policies and when the role can be deleted. This helps ensure that the\n service is not broken by an unexpectedly changed or deleted role, which could put your\n AWS resources into an unknown state. Allowing the service to control the role helps\n improve service stability and proper cleanup when a service and its role are no longer\n needed. For more information, see Using service-linked\n roles in the IAM User Guide.
\nTo attach a policy to this service-linked role, you must make the request using the\n AWS service that depends on this role.
" } }, "com.amazonaws.iam#CreateServiceLinkedRoleRequest": { "type": "structure", "members": { "AWSServiceName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The service principal for the AWS service to which this role is attached. You use a\n string similar to a URL but without the http:// in front. For example:\n elasticbeanstalk.amazonaws.com
.
Service principals are unique and case-sensitive. To find the exact service principal\n for your service-linked role, see AWS services\n that work with IAM in the IAM User Guide. Look for\n the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that\n service.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.iam#roleDescriptionType", "traits": { "smithy.api#documentation": "The description of the role.
" } }, "CustomSuffix": { "target": "com.amazonaws.iam#customSuffixType", "traits": { "smithy.api#documentation": "\nA string that you provide, which is combined with the service-provided prefix to form\n the complete role name. If you make multiple requests for the same service, then you\n must supply a different CustomSuffix
for each request. Otherwise the\n request fails with a duplicate role name error. For example, you could add\n -1
or -debug
to the suffix.
Some services do not support the CustomSuffix
parameter. If you provide\n an optional suffix and the operation fails, try the operation again without the\n suffix.
A Role object that contains details about the newly created\n role.
" } } } }, "com.amazonaws.iam#CreateServiceSpecificCredential": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateServiceSpecificCredentialRequest" }, "output": { "target": "com.amazonaws.iam#CreateServiceSpecificCredentialResponse" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceNotSupportedException" } ], "traits": { "smithy.api#documentation": "Generates a set of credentials consisting of a user name and password that can be used\n to access the service specified in the request. These credentials are generated by\n IAM, and can be used only for the specified service.
\nYou can have a maximum of two sets of service-specific credentials for each supported\n service per user.
\nYou can create service-specific credentials for AWS CodeCommit and Amazon Keyspaces (for Apache\n Cassandra).
\nYou can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
\nFor more information about service-specific credentials, see Using IAM\n with AWS CodeCommit: Git credentials, SSH keys, and AWS access keys in the\n IAM User Guide.
" } }, "com.amazonaws.iam#CreateServiceSpecificCredentialRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user that is to be associated with the credentials. The new\n service-specific credentials have the same permissions as the associated user except\n that they can be used only to access the specified service.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.iam#serviceName", "traits": { "smithy.api#documentation": "The name of the AWS service that is to be associated with the credentials. The\n service you specify here is the only service that can be accessed using these\n credentials.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#CreateServiceSpecificCredentialResponse": { "type": "structure", "members": { "ServiceSpecificCredential": { "target": "com.amazonaws.iam#ServiceSpecificCredential", "traits": { "smithy.api#documentation": "A structure that contains information about the newly created service-specific\n credential.
\nThis is the only time that the password for this credential set is available. It\n cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.
\nCreates a new IAM user for your AWS account.
\nFor information about quotas for the number of IAM users you can create, see IAM and STS\n quotas in the IAM User Guide.
" } }, "com.amazonaws.iam#CreateUserRequest": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path for the user name. For more information about paths, see IAM\n identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The name of the user to create.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
", "smithy.api#required": {} } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the policy that is used to set the permissions boundary for the\n user.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nA structure with details about the new IAM user.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateUser request.
" } }, "com.amazonaws.iam#CreateVirtualMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateVirtualMFADeviceRequest" }, "output": { "target": "com.amazonaws.iam#CreateVirtualMFADeviceResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates a new virtual MFA device for the AWS account. After creating the virtual\n MFA, use EnableMFADevice to attach the MFA device to an IAM user.\n For more information about creating and working with virtual MFA devices, see Using a virtual MFA\n device in the IAM User Guide.
\nFor information about the maximum number of MFA devices you can create, see IAM and STS\n quotas in the IAM User Guide.
\nThe seed information contained in the QR code and the Base32 string should be\n treated like any other secret access information. In other words, protect the seed\n information as you would your AWS access keys or your passwords. After you\n provision your virtual device, you should ensure that the information is destroyed\n following secure procedures.
\nThe path for the virtual MFA device. For more information about paths, see IAM\n identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA\n device.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that you want to attach to the new IAM virtual MFA device.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nA structure containing details about the new virtual MFA device.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateVirtualMFADevice request.\n
" } }, "com.amazonaws.iam#CredentialReportExpiredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#credentialReportExpiredExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the most recent credential report has expired. To\n generate a new credential report, use GenerateCredentialReport. For more\n information about credential report expiration, see Getting credential reports in the\n IAM User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 410 } }, "com.amazonaws.iam#CredentialReportNotPresentException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#credentialReportNotPresentExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the credential report does not exist. To generate a\n credential report, use GenerateCredentialReport.
", "smithy.api#error": "client", "smithy.api#httpError": 410 } }, "com.amazonaws.iam#CredentialReportNotReadyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#credentialReportNotReadyExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the credential report is still being generated.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iam#DeactivateMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeactivateMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deactivates the specified MFA device and removes it from association with the user\n name for which it was originally enabled.
\nFor more information about creating and working with virtual MFA devices, see Enabling a virtual\n multi-factor authentication (MFA) device in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DeactivateMFADeviceRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user whose MFA device you want to deactivate.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the device ARN.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteAccessKeyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the access key pair associated with the specified IAM user.
\nIf you do not specify a user name, IAM determines the user name implicitly based on\n the AWS access key ID signing the request. This operation works for access keys under\n the AWS account. Consequently, you can use this operation to manage AWS account root\n user credentials even if the AWS account has no associated users.
" } }, "com.amazonaws.iam#DeleteAccessKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user whose access key pair you want to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "The access key ID for the access key ID and secret access key you want to\n delete.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteAccountAlias": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteAccountAliasRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified AWS account alias. For information about using an AWS\n account alias, see Using an alias for your AWS account ID in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DeleteAccountAliasRequest": { "type": "structure", "members": { "AccountAlias": { "target": "com.amazonaws.iam#accountAliasType", "traits": { "smithy.api#documentation": "The name of the account alias to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of \n lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have \n two dashes in a row.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteAccountPasswordPolicy": { "type": "operation", "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the password policy for the AWS account. There are no parameters.
" } }, "com.amazonaws.iam#DeleteConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#deleteConflictMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it attempted to delete a resource that has attached\n subordinate entities. The error message describes these entities.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#DeleteGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteGroupRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified IAM group. The group must not contain any users or have any\n attached policies.
" } }, "com.amazonaws.iam#DeleteGroupPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteGroupPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified inline policy that is embedded in the specified IAM\n group.
\nA group can also have managed policies attached to it. To detach a managed policy from\n a group, use DetachGroupPolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#DeleteGroupPolicyRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the group that the policy is embedded\n in.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name identifying the policy document to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteGroupRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name of the IAM group to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteInstanceProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified instance profile. The instance profile must not have an\n associated role.
\nMake sure that you do not have any Amazon EC2 instances running with the instance\n profile you are about to delete. Deleting a role or instance profile that is\n associated with a running instance will break any applications running on the\n instance.
\nFor more information about instance profiles, see About instance\n profiles.
" } }, "com.amazonaws.iam#DeleteInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the instance profile to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteLoginProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the password for the specified IAM user, which terminates the user's ability\n to access AWS services through the AWS Management Console.
\nYou can use the AWS CLI, the AWS API, or the Users page in the IAM console to delete a password for any IAM user.\n You can use ChangePassword to update, but not delete, your own\n password in the My Security Credentials page in the\n AWS Management Console.
\nDeleting a user's password does not prevent a user from accessing AWS through\n the command line interface or the API. To prevent all user access, you must also\n either make any access keys inactive or delete them. For more information about\n making keys inactive or deleting them, see UpdateAccessKey and\n DeleteAccessKey.
\nThe name of the user whose password you want to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
\nDeleting an IAM OIDC provider resource does not update any roles that reference the\n provider as a principal in their trust policies. Any attempt to assume a role that\n references a deleted provider fails.
\nThis operation is idempotent; it does not fail or return an error if you call the\n operation for a provider that does not exist.
" } }, "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to\n delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeletePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified managed policy.
\nBefore you can delete a managed policy, you must first detach the policy from all\n users, groups, and roles that it is attached to. In addition, you must delete all the\n policy's versions. The following steps describe the process for deleting a managed\n policy:
\nDetach the policy from all users, groups, and roles that the policy is\n attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To\n list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
\nDelete all versions of the policy using DeletePolicyVersion.\n To list the policy's versions, use ListPolicyVersions. You\n cannot use DeletePolicyVersion to delete the version that is\n marked as the default version. You delete the policy's default version in the\n next step of the process.
\nDelete the policy (this automatically deletes the policy's default version)\n using this operation.
\nFor information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#DeletePolicyRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to delete.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeletePolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeletePolicyVersionRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified version from the specified managed policy.
\nYou cannot delete the default version from a policy using this operation. To delete\n the default version from a policy, use DeletePolicy. To find out which\n version of a policy is marked as the default version, use ListPolicyVersions.
\nFor information about versions for managed policies, see Versioning for managed\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#DeletePolicyVersionRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a\n version.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.iam#policyVersionIdType", "traits": { "smithy.api#documentation": "The policy version to delete.
\nThis parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.
\nFor more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteRoleRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Deletes the specified role. The role must not have any policies attached. For more\n information about roles, see Working with roles.
\nMake sure that you do not have any Amazon EC2 instances running with the role you\n are about to delete. Deleting a role or instance profile that is associated with a\n running instance will break any applications running on the instance.
\nDeletes the permissions boundary for the specified IAM role.
\nDeleting the permissions boundary for a role might increase its permissions. For\n example, it might allow anyone who assumes the role to perform all the actions\n granted in its permissions policies.
\nThe name (friendly name, not ARN) of the IAM role from which you want to remove the\n permissions boundary.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteRolePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Deletes the specified inline policy that is embedded in the specified IAM\n role.
\nA role can also have managed policies attached to it. To detach a managed policy from\n a role, use DetachRolePolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#DeleteRolePolicyRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the role that the policy is embedded\n in.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the inline policy to delete from the specified IAM role.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSAMLProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes a SAML provider resource in IAM.
\nDeleting the provider resource from IAM does not update any roles that reference the\n SAML provider resource's ARN as a principal in their trust policies. Any attempt to\n assume a role that references a non-existent provider resource ARN fails.
\nThis operation requires Signature Version 4.
\nThe Amazon Resource Name (ARN) of the SAML provider to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSSHPublicKeyRequest" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Deletes the specified SSH public key.
\nThe SSH public key deleted by this operation is used only for authenticating the\n associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys\n to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for\n SSH connections in the AWS CodeCommit User Guide.
" } }, "com.amazonaws.iam#DeleteSSHPublicKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SSHPublicKeyId": { "target": "com.amazonaws.iam#publicKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteServerCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified server certificate.
\nFor more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of AWS services that can use the server certificates that\n you manage with IAM.
\nIf you are using a server certificate with Elastic Load Balancing, deleting the\n certificate could have implications for your application. If Elastic Load Balancing\n doesn't detect the deletion of bound certificates, it may continue to use the\n certificates. This could cause Elastic Load Balancing to stop accepting traffic. We\n recommend that you remove the reference to the certificate from Elastic Load\n Balancing before using this command to delete the certificate. For more information,\n see DeleteLoadBalancerListeners in the Elastic Load Balancing API\n Reference.
\nThe name of the server certificate you want to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteServiceLinkedRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteServiceLinkedRoleRequest" }, "output": { "target": "com.amazonaws.iam#DeleteServiceLinkedRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Submits a service-linked role deletion request and returns a\n DeletionTaskId
, which you can use to check the status of the deletion.\n Before you call this operation, confirm that the role has no active sessions and that\n any resources used by the role in the linked service are deleted. If you call this\n operation more than once for the same service-linked role and an earlier deletion task\n is not complete, then the DeletionTaskId
of the earlier request is\n returned.
If you submit a deletion request for a service-linked role whose linked service is\n still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the\n failure, usually including the resources that must be deleted. To delete the\n service-linked role, you must first remove those resources from the linked service and\n then submit the deletion request again. Resources are specific to the service that is\n linked to the role. For more information about removing resources from a service, see\n the AWS documentation for your\n service.
\nFor more information about service-linked roles, see Roles terms and concepts: AWS service-linked role in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DeleteServiceLinkedRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the service-linked role to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteServiceLinkedRoleResponse": { "type": "structure", "members": { "DeletionTaskId": { "target": "com.amazonaws.iam#DeletionTaskIdType", "traits": { "smithy.api#documentation": "The deletion task identifier that you can use to check the status of the deletion.\n This identifier is returned in the format\n task/aws-service-role/
.
Deletes the specified service-specific credential.
" } }, "com.amazonaws.iam#DeleteServiceSpecificCredentialRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "The unique identifier of the service-specific credential. You can get this value by\n calling ListServiceSpecificCredentials.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSigningCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes a signing certificate associated with the specified IAM user.
\nIf you do not specify a user name, IAM determines the user name implicitly based on\n the AWS access key ID signing the request. This operation works for access keys under\n the AWS account. Consequently, you can use this operation to manage AWS account root\n user credentials even if the AWS account has no associated IAM users.
" } }, "com.amazonaws.iam#DeleteSigningCertificateRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user the signing certificate belongs to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "CertificateId": { "target": "com.amazonaws.iam#certificateIdType", "traits": { "smithy.api#documentation": "The ID of the signing certificate to delete.
\nThe format of this parameter, as described by its regex pattern, is a string of\n characters that can be upper- or lower-cased letters or digits.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteUserRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified IAM user. Unlike the AWS Management Console, when you delete a user\n programmatically, you must delete the items attached to the user manually, or the\n deletion fails. For more information, see Deleting an IAM\n user. Before attempting to delete a user, remove the following items:
\nPassword (DeleteLoginProfile)
\nAccess keys (DeleteAccessKey)
\nSigning certificate (DeleteSigningCertificate)
\nSSH public key (DeleteSSHPublicKey)
\nGit credentials (DeleteServiceSpecificCredential)
\nMulti-factor authentication (MFA) device (DeactivateMFADevice, DeleteVirtualMFADevice)
\nInline policies (DeleteUserPolicy)
\nAttached managed policies (DetachUserPolicy)
\nGroup memberships (RemoveUserFromGroup)
\nDeletes the permissions boundary for the specified IAM user.
\nDeleting the permissions boundary for a user might increase its permissions by\n allowing the user to perform all the actions granted in its permissions policies.\n
\nThe name (friendly name, not ARN) of the IAM user from which you want to remove the\n permissions boundary.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteUserPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified inline policy that is embedded in the specified IAM\n user.
\nA user can also have managed policies attached to it. To detach a managed policy from\n a user, use DetachUserPolicy. For more information about policies,\n refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#DeleteUserPolicyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the user that the policy is embedded\n in.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name identifying the policy document to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteUserRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user to delete.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeleteVirtualMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteVirtualMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes a virtual MFA device.
\nYou must deactivate a user's virtual MFA device before you can delete it. For\n information about deactivating MFA devices, see DeactivateMFADevice.
\nThe serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the same as the ARN.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DeletionTaskFailureReasonType": { "type": "structure", "members": { "Reason": { "target": "com.amazonaws.iam#ReasonType", "traits": { "smithy.api#documentation": "A short description of the reason that the service-linked role deletion failed.
" } }, "RoleUsageList": { "target": "com.amazonaws.iam#RoleUsageListType", "traits": { "smithy.api#documentation": "A list of objects that contains details about the service-linked role deletion failure,\n if that information is returned by the service. If the service-linked role has active\n sessions or if any resources that were used by the role have not been deleted from the\n linked service, the role can't be deleted. This parameter includes a list of the resources\n that are associated with the role and the Region in which the resources are being\n used.
" } } }, "traits": { "smithy.api#documentation": "The reason that the service-linked role deletion failed.
\nThis data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
" } }, "com.amazonaws.iam#DeletionTaskIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.iam#DeletionTaskStatusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SUCCEEDED", "name": "SUCCEEDED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "FAILED", "name": "FAILED" }, { "value": "NOT_STARTED", "name": "NOT_STARTED" } ] } }, "com.amazonaws.iam#DetachGroupPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachGroupPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified managed policy from the specified IAM group.
\nA group can also have inline policies embedded with it. To delete an inline policy,\n use DeleteGroupPolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DetachGroupPolicyRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the IAM group to detach the policy from.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DetachRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachRolePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Removes the specified managed policy from the specified role.
\nA role can also have inline policies embedded with it. To delete an inline policy, use\n DeleteRolePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DetachRolePolicyRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the IAM role to detach the policy from.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DetachUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachUserPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified managed policy from the specified user.
\nA user can also have inline policies embedded with it. To delete an inline policy, use\n DeleteUserPolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
" } }, "com.amazonaws.iam#DetachUserPolicyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the IAM user to detach the policy from.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy you want to detach.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#DuplicateCertificateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#duplicateCertificateMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the same certificate is associated with an IAM user in\n the account.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#DuplicateSSHPublicKeyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#duplicateSSHPublicKeyMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the SSH public key is already associated with the\n specified IAM user.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#EnableMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#EnableMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#InvalidAuthenticationCodeException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Enables the specified MFA device and associates it with the specified IAM user. When\n enabled, the MFA device is required for every subsequent login by the IAM user\n associated with the device.
" } }, "com.amazonaws.iam#EnableMFADeviceRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the IAM user for whom you want to enable the MFA device.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The serial number that uniquely identifies the MFA device. For virtual MFA devices,\n the serial number is the device ARN.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of upper and lowercase alphanumeric characters with no spaces. You can also include any of the \n following characters: =,.@:/-
", "smithy.api#required": {} } }, "AuthenticationCode1": { "target": "com.amazonaws.iam#authenticationCodeType", "traits": { "smithy.api#documentation": "An authentication code emitted by the device.
\nThe format for this parameter is a string of six digits.
\nSubmit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the\n device.
\nA subsequent authentication code emitted by the device.
\nThe format for this parameter is a string of six digits.
\nSubmit your request immediately after generating the authentication codes. If you\n generate the codes and then wait too long to submit the request, the MFA device\n successfully associates with the user but the MFA device becomes out of sync. This\n happens because time-based one-time passwords (TOTP) expire after a short period of\n time. If this happens, you can resync the\n device.
\nThe request was rejected because it attempted to create a resource that already\n exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#EntityDetails": { "type": "structure", "members": { "EntityInfo": { "target": "com.amazonaws.iam#EntityInfo", "traits": { "smithy.api#documentation": "The EntityInfo
object that contains details about the entity (user or\n role).
The date and time, in ISO 8601 date-time\n format, when the authenticated entity last attempted to access AWS. AWS does\n not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } } }, "traits": { "smithy.api#documentation": "An object that contains details about when the IAM entities (users or roles) were last\n used in an attempt to access the specified AWS service.
\nThis data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.
" } }, "com.amazonaws.iam#EntityInfo": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the entity (user or role).
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.iam#policyOwnerEntityType", "traits": { "smithy.api#documentation": "The type of entity (user or role).
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The identifier of the entity (user or role).
", "smithy.api#required": {} } }, "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the entity (user or role). For more information about paths, see IAM\n identifiers in the IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the specified entity (user or role).
\nThis data type is an element of the EntityDetails object.
" } }, "com.amazonaws.iam#EntityTemporarilyUnmodifiableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#entityTemporarilyUnmodifiableMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it referenced an entity that is temporarily unmodifiable,\n such as a user name that was deleted and then recreated. The error indicates that the request\n is likely to succeed if you try again after waiting several minutes. The error message\n describes the entity.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#EntityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "User", "name": "User" }, { "value": "Role", "name": "Role" }, { "value": "Group", "name": "Group" }, { "value": "LocalManagedPolicy", "name": "LocalManagedPolicy" }, { "value": "AWSManagedPolicy", "name": "AWSManagedPolicy" } ] } }, "com.amazonaws.iam#ErrorDetails": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "Detailed information about the reason that the operation failed.
", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The error code associated with the operation failure.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the reason that the operation failed.
\nThis data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.
" } }, "com.amazonaws.iam#EvalDecisionDetailsType": { "type": "map", "key": { "target": "com.amazonaws.iam#EvalDecisionSourceType" }, "value": { "target": "com.amazonaws.iam#PolicyEvaluationDecisionType" } }, "com.amazonaws.iam#EvalDecisionSourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 } } }, "com.amazonaws.iam#EvaluationResult": { "type": "structure", "members": { "EvalActionName": { "target": "com.amazonaws.iam#ActionNameType", "traits": { "smithy.api#documentation": "The name of the API operation tested on the indicated resource.
", "smithy.api#required": {} } }, "EvalResourceName": { "target": "com.amazonaws.iam#ResourceNameType", "traits": { "smithy.api#documentation": "The ARN of the resource that the indicated API operation was tested on.
" } }, "EvalDecision": { "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", "traits": { "smithy.api#documentation": "The result of the simulation.
", "smithy.api#required": {} } }, "MatchedStatements": { "target": "com.amazonaws.iam#StatementListType", "traits": { "smithy.api#documentation": "A list of the statements in the input policies that determine the result for this\n scenario. Remember that even if multiple statements allow the operation on the resource, if\n only one statement denies that operation, then the explicit deny overrides any allow. In\n addition, the deny statement is the only entry included in the result.
" } }, "MissingContextValues": { "target": "com.amazonaws.iam#ContextKeyNamesResultListType", "traits": { "smithy.api#documentation": "A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when the resource in a\n simulation is \"*\", either explicitly, or when the ResourceArns
parameter\n blank. If you include a list of resources, then any missing context values are instead\n included under the ResourceSpecificResults
section. To discover the context\n keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
A structure that details how Organizations and its service control policies affect the results of\n the simulation. Only applies if the simulated user's account is part of an\n organization.
" } }, "PermissionsBoundaryDecisionDetail": { "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", "traits": { "smithy.api#documentation": "Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.
" } }, "EvalDecisionDetails": { "target": "com.amazonaws.iam#EvalDecisionDetailsType", "traits": { "smithy.api#documentation": "Additional details about the results of the cross-account evaluation decision. This\n parameter is populated for only cross-account simulations. It contains a brief summary of\n how each policy type contributes to the final evaluation decision.
\nIf the simulation evaluates policies within the same account and includes a resource\n ARN, then the parameter is present but the response is empty. If the simulation evaluates\n policies within the same account and specifies all resources (*
), then the\n parameter is not returned.
When you make a cross-account request, AWS evaluates the request in the trusting\n account and the trusted account. The request is allowed only if both evaluations return\n true
. For more information about how policies are evaluated, see Evaluating policies within a single account.
If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In\n this case, policy evaluation does not proceed any further and this parameter is not\n returned.
" } }, "ResourceSpecificResults": { "target": "com.amazonaws.iam#ResourceSpecificResultListType", "traits": { "smithy.api#documentation": "The individual results of the simulation of the API operation specified in\n EvalActionName on each resource.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of a simulation.
\nThis data type is used by the return parameter of \n SimulateCustomPolicy\n
and \n SimulatePrincipalPolicy\n
.
Generates a credential report for the AWS account. For more information about the\n credential report, see Getting credential reports in\n the IAM User Guide.
" } }, "com.amazonaws.iam#GenerateCredentialReportResponse": { "type": "structure", "members": { "State": { "target": "com.amazonaws.iam#ReportStateType", "traits": { "smithy.api#documentation": "Information about the state of the credential report.
" } }, "Description": { "target": "com.amazonaws.iam#ReportStateDescriptionType", "traits": { "smithy.api#documentation": "Information about the credential report.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GenerateCredentialReport\n request.
" } }, "com.amazonaws.iam#GenerateOrganizationsAccessReport": { "type": "operation", "input": { "target": "com.amazonaws.iam#GenerateOrganizationsAccessReportRequest" }, "output": { "target": "com.amazonaws.iam#GenerateOrganizationsAccessReportResponse" }, "errors": [ { "target": "com.amazonaws.iam#ReportGenerationLimitExceededException" } ], "traits": { "smithy.api#documentation": "Generates a report for service last accessed data for AWS Organizations. You can generate a report\n for any entities (organization root, organizational unit, or account) or policies in\n your organization.
\nTo call this operation, you must be signed in using your AWS Organizations management account\n credentials. You can use your long-term IAM user or root user credentials, or\n temporary credentials from assuming an IAM role. SCPs must be enabled for your\n organization root. You must have the required IAM and AWS Organizations permissions. For more\n information, see Refining permissions using\n service last accessed data in the\n IAM User Guide.
\nYou can generate a service last accessed data report for entities by specifying only\n the entity's path. This data includes a list of services that are allowed by any service\n control policies (SCPs) that apply to the entity.
\nYou can generate a service last accessed data report for a policy by specifying an\n entity's path and an optional AWS Organizations policy ID. This data includes a list of services that\n are allowed by the specified SCP.
\nFor each service in both report types, the data includes the most recent account\n activity that the policy allows to account principals in the entity or the entity's\n children. For important information about the data, reporting period, permissions\n required, troubleshooting, and supported Regions see Reducing permissions using\n service last accessed data in the\n IAM User Guide.
\nThe data includes all attempts to access AWS, not just the successful ones. This\n includes all attempts that were made using the AWS Management Console, the AWS API through any\n of the SDKs, or any of the command line tools. An unexpected entry in the service\n last accessed data does not mean that an account has been compromised, because the\n request might have been denied. Refer to your CloudTrail logs as the authoritative\n source for information about all API calls and whether they were successful or\n denied access. For more information, see Logging IAM events with\n CloudTrail in the IAM User Guide.
\nThis operation returns a JobId
. Use this parameter in the \n GetOrganizationsAccessReport\n
operation to check the status of\n the report generation. To check the status of this request, use the JobId
\n parameter in the \n GetOrganizationsAccessReport\n
operation\n and test the JobStatus
response parameter. When the job is complete, you\n can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path\n without specifying the optional AWS Organizations policy ID. The type of entity that you specify\n determines the data returned in the report.
\n\n Root – When you specify the\n organizations root as the entity, the resulting report lists all of the services\n allowed by SCPs that are attached to your root. For each service, the report\n includes data for all accounts in your organization except the\n management account, because the management account is not limited by SCPs.
\n\n OU – When you specify an\n organizational unit (OU) as the entity, the resulting report lists all of the\n services allowed by SCPs that are attached to the OU and its parents. For each\n service, the report includes data for all accounts in the OU or its children.\n This data excludes the management account, because the management account is not\n limited by SCPs.
\n\n management account – When you specify the\n management account, the resulting report lists all AWS services, because the\n management account is not limited by SCPs. For each service, the report includes\n data for only the management account.
\n\n Account – When you specify another\n account as the entity, the resulting report lists all of the services allowed by\n SCPs that are attached to the account and its parents. For each service, the\n report includes data for only the specified account.
\nTo generate a service last accessed data report for policies, specify an entity path\n and the optional AWS Organizations policy ID. The type of entity that you specify determines the data\n returned for each service.
\n\n Root – When you specify the root\n entity and a policy ID, the resulting report lists all of the services that are\n allowed by the specified SCP. For each service, the report includes data for all\n accounts in your organization to which the SCP applies. This data excludes the\n management account, because the management account is not limited by SCPs. If the\n SCP is not attached to any entities in the organization, then the report will\n return a list of services with no data.
\n\n OU – When you specify an OU entity and\n a policy ID, the resulting report lists all of the services that are allowed by\n the specified SCP. For each service, the report includes data for all accounts\n in the OU or its children to which the SCP applies. This means that other\n accounts outside the OU that are affected by the SCP might not be included in\n the data. This data excludes the management account, because the\n management account is not limited by SCPs. If the SCP is not attached to the OU\n or one of its children, the report will return a list of services with no\n data.
\n\n management account – When you specify the\n management account, the resulting report lists all AWS services, because the\n management account is not limited by SCPs. If you specify a policy ID in the CLI\n or API, the policy is ignored. For each service, the report includes data for\n only the management account.
\n\n Account – When you specify another\n account entity and a policy ID, the resulting report lists all of the services\n that are allowed by the specified SCP. For each service, the report includes\n data for only the specified account. This means that other accounts in the\n organization that are affected by the SCP might not be included in the data. If\n the SCP is not attached to the account, the report will return a list of\n services with no data.
\nService last accessed data does not use other policy types when determining\n whether a principal could access a service. These other policy types include\n identity-based policies, resource-based policies, access control lists, IAM\n permissions boundaries, and STS assume role policies. It only applies SCP logic.\n For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.
\nFor more information about service last accessed data, see Reducing policy scope by\n viewing user activity in the IAM User Guide.
" } }, "com.amazonaws.iam#GenerateOrganizationsAccessReportRequest": { "type": "structure", "members": { "EntityPath": { "target": "com.amazonaws.iam#organizationsEntityPathType", "traits": { "smithy.api#documentation": "The path of the AWS Organizations entity (root, OU, or account). You can build an entity path using\n the known structure of your organization. For example, assume that your account ID is\n 123456789012
and its parent OU ID is ou-rge0-awsabcde
. The\n organization root ID is r-f6g7h8i9j0example
and your organization ID is\n o-a1b2c3d4e5
. Your entity path is\n o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012
.
The identifier of the AWS Organizations service control policy (SCP). This parameter is\n optional.
\nThis ID is used to generate information about when an account principal that is\n limited by the SCP attempted to access an AWS service.
" } } } }, "com.amazonaws.iam#GenerateOrganizationsAccessReportResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { "smithy.api#documentation": "The job identifier that you can use in the GetOrganizationsAccessReport operation.
" } } } }, "com.amazonaws.iam#GenerateServiceLastAccessedDetails": { "type": "operation", "input": { "target": "com.amazonaws.iam#GenerateServiceLastAccessedDetailsRequest" }, "output": { "target": "com.amazonaws.iam#GenerateServiceLastAccessedDetailsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Generates a report that includes details about when an IAM resource (user, group,\n role, or policy) was last used in an attempt to access AWS services. Recent activity\n usually appears within four hours. IAM reports activity for the last 365 days, or less\n if your Region began supporting this feature within the last year. For more information,\n see Regions where data is tracked.
\nThe service last accessed data includes all attempts to access an AWS API, not\n just the successful ones. This includes all attempts that were made using the\n AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools.\n An unexpected entry in the service last accessed data does not mean that your\n account has been compromised, because the request might have been denied. Refer to\n your CloudTrail logs as the authoritative source for information about all API calls\n and whether they were successful or denied access. For more information, see Logging\n IAM events with CloudTrail in the\n IAM User Guide.
\nThe GenerateServiceLastAccessedDetails
operation returns a\n JobId
. Use this parameter in the following operations to retrieve the\n following details from your report:
\n GetServiceLastAccessedDetails – Use this operation\n for users, groups, roles, or policies to list every AWS service that the\n resource could access using permissions policies. For each service, the response\n includes information about the most recent access attempt.
\nThe JobId
returned by\n GenerateServiceLastAccessedDetail
must be used by the same role\n within a session, or by the same user when used to call\n GetServiceLastAccessedDetail
.
\n GetServiceLastAccessedDetailsWithEntities – Use this\n operation for groups and policies to list information about the associated\n entities (users or roles) that attempted to access a specific AWS service.\n
\nTo check the status of the GenerateServiceLastAccessedDetails
request,\n use the JobId
parameter in the same operations and test the\n JobStatus
response parameter.
For additional information about the permissions policies that allow an identity\n (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.
\nService last accessed data does not use other policy types when determining\n whether a resource could access a service. These other policy types include\n resource-based policies, access control lists, AWS Organizations policies, IAM\n permissions boundaries, and AWS STS assume role policies. It only applies\n permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.
\nFor more information about service and action last accessed data, see Reducing permissions using service last accessed data in the\n IAM User Guide.
" } }, "com.amazonaws.iam#GenerateServiceLastAccessedDetailsRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the IAM resource (user, group, role, or managed policy) used to generate\n information about when the resource was last used in an attempt to access an AWS\n service.
", "smithy.api#required": {} } }, "Granularity": { "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", "traits": { "smithy.api#documentation": "The level of detail that you want to generate. You can specify whether you want to\n generate information about the last attempt to access services or actions. If you\n specify service-level granularity, this operation generates only service data. If you\n specify action-level granularity, it generates service and action data. If you don't\n include this optional parameter, the operation generates service data.
" } } } }, "com.amazonaws.iam#GenerateServiceLastAccessedDetailsResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { "smithy.api#documentation": "The JobId
that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The\n JobId
returned by GenerateServiceLastAccessedDetail
must\n be used by the same role within a session, or by the same user when used to call\n GetServiceLastAccessedDetail
.
Retrieves information about when the specified access key was last used. The\n information includes the date and time of last use, along with the AWS service and\n Region that were specified in the last request made with that key.
" } }, "com.amazonaws.iam#GetAccessKeyLastUsedRequest": { "type": "structure", "members": { "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "The identifier of an access key.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetAccessKeyLastUsedResponse": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the AWS IAM user that owns this access key.
\n " } }, "AccessKeyLastUsed": { "target": "com.amazonaws.iam#AccessKeyLastUsed", "traits": { "smithy.api#documentation": "Contains information about the last time the access key was used.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetAccessKeyLastUsed request.\n It is also returned as a member of the AccessKeyMetaData structure returned\n by the ListAccessKeys action.
" } }, "com.amazonaws.iam#GetAccountAuthorizationDetails": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetAccountAuthorizationDetailsRequest" }, "output": { "target": "com.amazonaws.iam#GetAccountAuthorizationDetailsResponse" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about all IAM users, groups, roles, and policies in your AWS\n account, including their relationships to one another. Use this operation to obtain a\n snapshot of the configuration of IAM permissions (users, groups, roles, and policies)\n in your account.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter
parameter. You can\n paginate the results using the MaxItems
and Marker
\n parameters.
A list of entity types used to filter the results. Only the entities that match the\n types you specify are included in the output. Use the value\n LocalManagedPolicy
to include customer managed policies.
The format for this parameter is a comma-separated (if more than one) list of strings.\n Each string value in the list must be one of the valid values listed below.
" } }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { "smithy.api#documentation": "Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
A list containing information about IAM users.
" } }, "GroupDetailList": { "target": "com.amazonaws.iam#groupDetailListType", "traits": { "smithy.api#documentation": "A list containing information about IAM groups.
" } }, "RoleDetailList": { "target": "com.amazonaws.iam#roleDetailListType", "traits": { "smithy.api#documentation": "A list containing information about IAM roles.
" } }, "Policies": { "target": "com.amazonaws.iam#ManagedPolicyDetailListType", "traits": { "smithy.api#documentation": "A list containing information about managed policies.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful GetAccountAuthorizationDetails\n request.
" } }, "com.amazonaws.iam#GetAccountPasswordPolicy": { "type": "operation", "output": { "target": "com.amazonaws.iam#GetAccountPasswordPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves the password policy for the AWS account. This tells you the complexity\n requirements and mandatory rotation periods for the IAM user passwords in your account.\n For more information about using a password policy, see Managing an IAM password\n policy.
" } }, "com.amazonaws.iam#GetAccountPasswordPolicyResponse": { "type": "structure", "members": { "PasswordPolicy": { "target": "com.amazonaws.iam#PasswordPolicy", "traits": { "smithy.api#documentation": "A structure that contains details about the account's password policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetAccountPasswordPolicy\n request.
" } }, "com.amazonaws.iam#GetAccountSummary": { "type": "operation", "output": { "target": "com.amazonaws.iam#GetAccountSummaryResponse" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about IAM entity usage and IAM quotas in the AWS\n account.
\nFor information about IAM quotas, see IAM and STS quotas in the\n IAM User Guide.
" } }, "com.amazonaws.iam#GetAccountSummaryResponse": { "type": "structure", "members": { "SummaryMap": { "target": "com.amazonaws.iam#summaryMapType", "traits": { "smithy.api#documentation": "A set of key–value pairs containing information about IAM entity usage and\n IAM quotas.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetAccountSummary request.\n
" } }, "com.amazonaws.iam#GetContextKeysForCustomPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetContextKeysForCustomPolicyRequest" }, "output": { "target": "com.amazonaws.iam#GetContextKeysForPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" } ], "traits": { "smithy.api#documentation": "Gets a list of all of the context keys referenced in the input policies. The policies\n are supplied as a list of one or more strings. To get the context keys from policies\n associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
\nContext keys are variables maintained by AWS and its services that provide details\n about the context of an API query request. Context keys can be evaluated by testing\n against a value specified in an IAM policy. Use\n GetContextKeysForCustomPolicy
to understand what key names and values\n you must supply when you call SimulateCustomPolicy. Note that all\n parameters are shown in unencoded form here for clarity but must be URL encoded to be\n 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\n policies. Each document is specified as a string containing the complete, valid JSON\n text of an IAM policy.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
The list of context keys that are referenced in the input policies.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
" } }, "com.amazonaws.iam#GetContextKeysForPrincipalPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetContextKeysForPrincipalPolicyRequest" }, "output": { "target": "com.amazonaws.iam#GetContextKeysForPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Gets a list of all of the context keys referenced in all the IAM policies that are\n attached to the specified IAM entity. The entity can be an IAM user, group, or role.\n If you specify a user, then the request also includes all of the policies attached to\n groups that the user is a member of.
\nYou can optionally include a list of one or more additional policies, specified as\n strings. If you want to include only a list of policies by string,\n use GetContextKeysForCustomPolicy instead.
\n\n Note: This operation discloses information about the\n permissions granted to other users. If you do not want users to see other user's\n permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.
\nContext keys are variables maintained by AWS and its services that provide details\n about the context of an API query request. Context keys can be evaluated by testing\n against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
" } }, "com.amazonaws.iam#GetContextKeysForPrincipalPolicyRequest": { "type": "structure", "members": { "PolicySourceArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of a user, group, or role whose policies contain the context keys that you\n want listed. If you specify a user, the list includes context keys that are found in all\n policies that are attached to the user. The list also includes all groups that the user\n is a member of. If you pick a group or a role, then it includes only those context keys\n that are found in policies attached to that entity. Note that all parameters are shown\n in unencoded form here for clarity, but must be URL encoded to be included as a part of\n a real HTML request.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "PolicyInputList": { "target": "com.amazonaws.iam#SimulationPolicyListType", "traits": { "smithy.api#documentation": "An optional list of additional policies for which you want the list of context keys\n that are referenced.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Retrieves a credential report for the AWS account. For more information about the\n credential report, see Getting credential reports in\n the IAM User Guide.
" } }, "com.amazonaws.iam#GetCredentialReportResponse": { "type": "structure", "members": { "Content": { "target": "com.amazonaws.iam#ReportContentType", "traits": { "smithy.api#documentation": "Contains the credential report. The report is Base64-encoded.
" } }, "ReportFormat": { "target": "com.amazonaws.iam#ReportFormatType", "traits": { "smithy.api#documentation": "The format (MIME type) of the credential report.
" } }, "GeneratedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the credential report was created, in ISO 8601 date-time format.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetCredentialReport request.\n
" } }, "com.amazonaws.iam#GetGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetGroupRequest" }, "output": { "target": "com.amazonaws.iam#GetGroupResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": " Returns a list of IAM users that are in the specified IAM group. You can paginate\n the results using the MaxItems
and Marker
parameters.
Retrieves the specified inline policy document that is embedded in the specified IAM\n group.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n 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\n policy document that is attached to a group, use GetPolicy to\n determine the policy's default version, then use GetPolicyVersion to\n retrieve the policy document.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#GetGroupPolicyRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name of the group the policy is associated with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document to get.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetGroupPolicyResponse": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The group the policy is associated with.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nIAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts\n a YAML policy to JSON format before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetGroupPolicy request.\n
" } }, "com.amazonaws.iam#GetGroupRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name of the group.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A structure that contains details about the group.
", "smithy.api#required": {} } }, "Users": { "target": "com.amazonaws.iam#userListType", "traits": { "smithy.api#documentation": "A list of users in the group.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful GetGroup request.
" } }, "com.amazonaws.iam#GetInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetInstanceProfileRequest" }, "output": { "target": "com.amazonaws.iam#GetInstanceProfileResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the specified instance profile, including the instance\n profile's path, GUID, ARN, and role. For more information about instance profiles, see\n About\n instance profiles in the IAM User Guide.
", "smithy.waiters#waitable": { "InstanceProfileExists": { "acceptors": [ { "state": "success", "matcher": { "success": true } }, { "state": "retry", "matcher": { "errorType": "NoSuchEntityException" } } ], "minDelay": 1 } } } }, "com.amazonaws.iam#GetInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the instance profile to get information about.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetInstanceProfileResponse": { "type": "structure", "members": { "InstanceProfile": { "target": "com.amazonaws.iam#InstanceProfile", "traits": { "smithy.api#documentation": "A structure containing details about the instance profile.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetInstanceProfile request.\n
" } }, "com.amazonaws.iam#GetLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetLoginProfileRequest" }, "output": { "target": "com.amazonaws.iam#GetLoginProfileResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves the user name and password creation date for the specified IAM user. If\n the user has not been assigned a password, the operation returns a 404\n (NoSuchEntity
) error.
The name of the user whose login profile you want to retrieve.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetLoginProfileResponse": { "type": "structure", "members": { "LoginProfile": { "target": "com.amazonaws.iam#LoginProfile", "traits": { "smithy.api#documentation": "A structure containing the user name and password create date for the user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetLoginProfile request.\n
" } }, "com.amazonaws.iam#GetOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetOpenIDConnectProviderRequest" }, "output": { "target": "com.amazonaws.iam#GetOpenIDConnectProviderResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Returns information about the specified OpenID Connect (OIDC) provider resource object\n in IAM.
" } }, "com.amazonaws.iam#GetOpenIDConnectProviderRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get\n information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetOpenIDConnectProviderResponse": { "type": "structure", "members": { "Url": { "target": "com.amazonaws.iam#OpenIDConnectProviderUrlType", "traits": { "smithy.api#documentation": "The URL that the IAM OIDC provider resource object is associated with. For more\n information, see CreateOpenIDConnectProvider.
" } }, "ClientIDList": { "target": "com.amazonaws.iam#clientIDListType", "traits": { "smithy.api#documentation": "A list of client IDs (also known as audiences) that are associated with the specified\n IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.
" } }, "ThumbprintList": { "target": "com.amazonaws.iam#thumbprintListType", "traits": { "smithy.api#documentation": "A list of certificate thumbprints that are associated with the specified IAM OIDC\n provider resource object. For more information, see CreateOpenIDConnectProvider.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the IAM OIDC provider resource object was created in the\n AWS account.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetOpenIDConnectProvider\n request.
" } }, "com.amazonaws.iam#GetOrganizationsAccessReport": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetOrganizationsAccessReportRequest" }, "output": { "target": "com.amazonaws.iam#GetOrganizationsAccessReportResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Retrieves the service last accessed data report for AWS Organizations that was previously generated\n using the \n GenerateOrganizationsAccessReport\n
operation.\n 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\n returned could include different information. For details, see GenerateOrganizationsAccessReport.
\nTo call this operation, you must be signed in to the management account in your\n organization. SCPs must be enabled for your organization root. You must have permissions\n to perform this operation. For more information, see Refining permissions using\n service last accessed data in the\n IAM User Guide.
\nFor each service that principals in an account (root users, IAM users, or IAM\n roles) could access using SCPs, the operation returns details about the most recent\n access attempt. If there was no attempt, the service is listed without details about the\n most recent attempt to access the service. If the operation fails, it returns the reason\n that it failed.
\nBy default, the list is sorted by service namespace.
" } }, "com.amazonaws.iam#GetOrganizationsAccessReportRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { "smithy.api#documentation": "The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
", "smithy.api#required": {} } }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { "smithy.api#documentation": "Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The key that is used to sort the results. If you choose the namespace key, the results\n are returned in alphabetical order. If you choose the time key, the results are sorted\n numerically by the date and time.
" } } } }, "com.amazonaws.iam#GetOrganizationsAccessReportResponse": { "type": "structure", "members": { "JobStatus": { "target": "com.amazonaws.iam#jobStatusType", "traits": { "smithy.api#documentation": "The status of the job.
", "smithy.api#required": {} } }, "JobCreationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the report job was created.
", "smithy.api#required": {} } }, "JobCompletionDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.
\nThis field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS
.
The number of services that the applicable SCPs allow account principals to\n access.
" } }, "NumberOfServicesNotAccessed": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The number of services that account principals are allowed but did not attempt to\n access.
" } }, "AccessDetails": { "target": "com.amazonaws.iam#AccessDetails", "traits": { "smithy.api#documentation": "An object that contains details about the most recent attempt to access the\n service.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Retrieves information about the specified managed policy, including the policy's\n default version and the total number of IAM users, groups, and roles to which the\n policy is attached. To retrieve the list of the specific users, groups, and roles that\n the policy is attached to, use ListEntitiesForPolicy. This operation\n returns metadata about the policy. To retrieve the actual policy document for a specific\n version of the policy, use GetPolicyVersion.
\nThis operation retrieves information about managed policies. To retrieve information\n about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#GetPolicyRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the managed policy that you want information\n about.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetPolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.iam#Policy", "traits": { "smithy.api#documentation": "A structure containing details about the policy.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetPolicy request.
" } }, "com.amazonaws.iam#GetPolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetPolicyVersionRequest" }, "output": { "target": "com.amazonaws.iam#GetPolicyVersionResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the specified version of the specified managed policy,\n including the policy document.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.
To list the available versions for a policy, use ListPolicyVersions.
\nThis operation retrieves information about managed policies. To retrieve information\n about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
\nFor more information about the types of policies, see Managed policies and inline\n policies in the IAM User Guide.
\nFor more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#GetPolicyVersionRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the managed policy that you want information\n about.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.iam#policyVersionIdType", "traits": { "smithy.api#documentation": "Identifies the policy version to retrieve.
\nThis parameter allows (through its regex pattern) a string of characters that \n consists of the lowercase letter 'v' followed by one or two digits, and optionally \n followed by a period '.' and a string of letters and digits.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetPolicyVersionResponse": { "type": "structure", "members": { "PolicyVersion": { "target": "com.amazonaws.iam#PolicyVersion", "traits": { "smithy.api#documentation": "A structure containing details about the policy version.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetPolicyVersion request.\n
" } }, "com.amazonaws.iam#GetRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetRoleRequest" }, "output": { "target": "com.amazonaws.iam#GetRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the specified role, including the role's path, GUID, ARN,\n and the role's trust policy that grants permission to assume the role. For more\n information about roles, see Working with roles.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n the Java SDK. Other languages and SDKs provide similar functionality.
Retrieves the specified inline policy document that is embedded with the specified\n IAM role.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n 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\n policy document that is attached to a role, use GetPolicy to determine\n the policy's default version, then use GetPolicyVersion to retrieve\n the policy document.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
\nFor more information about roles, see Using roles to delegate permissions and\n federate identities.
" } }, "com.amazonaws.iam#GetRolePolicyRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role associated with the policy.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document to get.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetRolePolicyResponse": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The role the policy is associated with.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nIAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts\n a YAML policy to JSON format before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetRolePolicy request.\n
" } }, "com.amazonaws.iam#GetRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the IAM role to get information about.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetRoleResponse": { "type": "structure", "members": { "Role": { "target": "com.amazonaws.iam#Role", "traits": { "smithy.api#documentation": "A structure containing details about the IAM role.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetRole request.
" } }, "com.amazonaws.iam#GetSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetSAMLProviderRequest" }, "output": { "target": "com.amazonaws.iam#GetSAMLProviderResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Returns the SAML provider metadocument that was uploaded when the IAM SAML provider\n resource object was created or updated.
\nThis operation requires Signature Version 4.
\nThe Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get\n information about.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetSAMLProviderResponse": { "type": "structure", "members": { "SAMLMetadataDocument": { "target": "com.amazonaws.iam#SAMLMetadataDocumentType", "traits": { "smithy.api#documentation": "The XML metadata document that includes information about an identity provider.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the SAML provider was created.
" } }, "ValidUntil": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The expiration date and time for the SAML provider.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetSAMLProvider request.\n
" } }, "com.amazonaws.iam#GetSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetSSHPublicKeyRequest" }, "output": { "target": "com.amazonaws.iam#GetSSHPublicKeyResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException" } ], "traits": { "smithy.api#documentation": "Retrieves the specified SSH public key, including metadata about the key.
\nThe SSH public key retrieved by this operation is used only for authenticating the\n associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys\n to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH\n connections in the AWS CodeCommit User Guide.
" } }, "com.amazonaws.iam#GetSSHPublicKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SSHPublicKeyId": { "target": "com.amazonaws.iam#publicKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } }, "Encoding": { "target": "com.amazonaws.iam#encodingType", "traits": { "smithy.api#documentation": "Specifies the public key encoding format to use in the response. To retrieve the\n public key in ssh-rsa format, use SSH
. To retrieve the public key in PEM\n format, use PEM
.
A structure containing details about the SSH public key.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetSSHPublicKey\n request.
" } }, "com.amazonaws.iam#GetServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetServerCertificateRequest" }, "output": { "target": "com.amazonaws.iam#GetServerCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the specified server certificate stored in IAM.
\nFor more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic includes a list of AWS services that can use the server certificates that you\n manage with IAM.
" } }, "com.amazonaws.iam#GetServerCertificateRequest": { "type": "structure", "members": { "ServerCertificateName": { "target": "com.amazonaws.iam#serverCertificateNameType", "traits": { "smithy.api#documentation": "The name of the server certificate you want to retrieve information about.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetServerCertificateResponse": { "type": "structure", "members": { "ServerCertificate": { "target": "com.amazonaws.iam#ServerCertificate", "traits": { "smithy.api#documentation": "A structure containing details about the server certificate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetServerCertificate request.\n
" } }, "com.amazonaws.iam#GetServiceLastAccessedDetails": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsRequest" }, "output": { "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Retrieves a service last accessed report that was created using the\n GenerateServiceLastAccessedDetails
operation. You can use the\n JobId
parameter in GetServiceLastAccessedDetails
to\n retrieve the status of your report job. When the report is complete, you can retrieve\n the generated report. The report includes a list of AWS services that the resource\n (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining\n whether a resource could access a service. These other policy types include\n resource-based policies, access control lists, AWS Organizations policies, IAM\n permissions boundaries, and AWS STS assume role policies. It only applies\n permissions policy logic. For more about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.
\nFor each service that the resource could access using permissions policies, the\n operation returns details about the most recent access attempt. If there was no attempt,\n the service is listed without details about the most recent attempt to access the\n service. If the operation fails, the GetServiceLastAccessedDetails
\n operation returns the reason that it failed.
The GetServiceLastAccessedDetails
operation returns a list of services.\n This list includes the number of entities that have attempted to access the service and\n the date and time of the last attempt. It also returns the ARN of the following entity,\n depending on the resource ARN that you used to generate the report:
\n User – Returns the user ARN that you\n used to generate the report
\n\n Group – Returns the ARN of the group\n member (user) that last attempted to access the service
\n\n Role – Returns the role ARN that you\n used to generate the report
\n\n Policy – Returns the ARN of the user\n or role that last used the policy to attempt to access the service
\nBy default, the list is sorted by service namespace.
\nIf you specified ACTION_LEVEL
granularity when you generated the report,\n this operation returns service and action last accessed data. This includes the most\n recent access attempt for each tracked action within a service. Otherwise, this\n 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\n IAM User Guide.
" } }, "com.amazonaws.iam#GetServiceLastAccessedDetailsRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { "smithy.api#documentation": "The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId
\n returned by GenerateServiceLastAccessedDetail
must be used by the same role\n within a session, or by the same user when used to call\n GetServiceLastAccessedDetail
.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The status of the job.
", "smithy.api#required": {} } }, "JobType": { "target": "com.amazonaws.iam#AccessAdvisorUsageGranularityType", "traits": { "smithy.api#documentation": "The type of job. Service jobs return information about when each service was last\n accessed. Action jobs also include information about when tracked actions within the\n service were last accessed.
" } }, "JobCreationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the report job was created.
", "smithy.api#required": {} } }, "ServicesLastAccessed": { "target": "com.amazonaws.iam#ServicesLastAccessed", "traits": { "smithy.api#documentation": " A ServiceLastAccessed
object that contains details about the most recent\n attempt to access the service.
The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.
\nThis field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS
.
A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
An object that contains details about the reason the operation failed.
" } } } }, "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntities": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesRequest" }, "output": { "target": "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "After you generate a group or policy report using the\n GenerateServiceLastAccessedDetails
operation, you can use the\n JobId
parameter in\n GetServiceLastAccessedDetailsWithEntities
. This operation retrieves the\n status of your report job and a list of entities that could have used group or policy\n permissions to access the specified service.
\n Group – For a group report, this\n operation returns a list of users in the group that could have used the group’s\n policies in an attempt to access the service.
\n\n Policy – For a policy report, this\n operation returns a list of entities (users or roles) that could have used the\n policy in an attempt to access the service.
\nYou can also use this operation for user or role reports to retrieve details about\n those entities.
\nIf the operation fails, the GetServiceLastAccessedDetailsWithEntities
\n operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent\n access listed first.
" } }, "com.amazonaws.iam#GetServiceLastAccessedDetailsWithEntitiesRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.iam#jobIDType", "traits": { "smithy.api#documentation": "The ID of the request generated by the GenerateServiceLastAccessedDetails
\n operation.
The service namespace for an AWS service. Provide the service namespace to learn\n when the IAM entity last attempted to access the specified service.
\nTo learn the service namespace for a service, see Actions, resources, and condition keys for AWS services in the\n IAM User Guide. Choose the name of the service to view\n details for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b)
. For more information about service namespaces,\n see AWS\n service namespaces in the AWS General Reference.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The status of the job.
", "smithy.api#required": {} } }, "JobCreationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the report job was created.
", "smithy.api#required": {} } }, "JobCompletionDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the generated report job was completed or failed.
\nThis field is null if the job is still in progress, as indicated by a job status value\n of IN_PROGRESS
.
An EntityDetailsList
object that contains details about when an IAM\n entity (user or role) used group or policy permissions in an attempt to access the\n specified AWS service.
A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
An object that contains details about the reason the operation failed.
" } } } }, "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatus": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusRequest" }, "output": { "target": "com.amazonaws.iam#GetServiceLinkedRoleDeletionStatusResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion,\n you can use the DeletionTaskId
parameter in\n GetServiceLinkedRoleDeletionStatus
to check the status of the deletion.\n If the deletion fails, this operation returns the reason that it failed, if that\n information is returned by the service.
The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format\n task/aws-service-role/
.
The status of the deletion.
", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.iam#DeletionTaskFailureReasonType", "traits": { "smithy.api#documentation": "An object that contains details about the reason the deletion failed.
" } } } }, "com.amazonaws.iam#GetUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetUserRequest" }, "output": { "target": "com.amazonaws.iam#GetUserResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the specified IAM user, including the user's creation\n date, path, unique ID, and ARN.
\nIf you do not specify a user name, IAM determines the user name implicitly based on\n the AWS access key ID used to sign the request to this operation.
" } }, "com.amazonaws.iam#GetUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetUserPolicyRequest" }, "output": { "target": "com.amazonaws.iam#GetUserPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves the specified inline policy document that is embedded in the specified IAM\n user.
\nPolicies returned by this operation are URL-encoded compliant \n with RFC 3986. You can use a URL \n decoding method to convert the policy back to plain JSON text. For example, if you use Java, you \n can use the decode
method of the java.net.URLDecoder
utility class in \n 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\n policy document that is attached to a user, use GetPolicy to determine\n the policy's default version. Then use GetPolicyVersion to retrieve\n the policy document.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#GetUserPolicyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user who the policy is associated with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document to get.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#GetUserPolicyResponse": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The user the policy is associated with.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nIAM stores policies in JSON format. However, resources that were created using AWS\n CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts\n a YAML policy to JSON format before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetUserPolicy request.\n
" } }, "com.amazonaws.iam#GetUserRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user to get information about.
\nThis parameter is optional. If it is not included, it defaults to the user making the\n request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } } } }, "com.amazonaws.iam#GetUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.iam#User", "traits": { "smithy.api#documentation": "A structure containing details about the IAM user.
\nDue to a service issue, password last used data does not include password use from\n 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\n dates in the IAM credential\n report, and returned by this operation. If users signed in during the\n affected time, the password last used date that is returned is the date the user\n last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08\n PDT, the returned password last used date is accurate.
\nYou can use password last used information to identify unused credentials for\n deletion. For example, you might delete users who did not sign in to AWS in the last\n 90 days. In cases like this, we recommend that you adjust your evaluation window to\n include dates after May 23, 2018. Alternatively, if your users use access keys to\n access AWS programmatically you can refer to access key last used information\n because it is accurate for all dates.
\nContains the response to a successful GetUser request.
" } }, "com.amazonaws.iam#Group": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the group. For more information about paths, see IAM identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The friendly name that identifies the group.
", "smithy.api#required": {} } }, "GroupId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) specifying the group. For more information about ARNs\n and how to use them in policies, see IAM identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the group was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM group entity.
\nThis data type is used as a response element in the following operations:
\n\n CreateGroup\n
\n\n GetGroup\n
\n\n ListGroups\n
\nThe path to the group. For more information about paths, see IAM identifiers in the\n IAM User Guide.
" } }, "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The friendly name that identifies the group.
" } }, "GroupId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } }, "Arn": { "target": "com.amazonaws.iam#arnType" }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the group was created.
" } }, "GroupPolicyList": { "target": "com.amazonaws.iam#policyDetailListType", "traits": { "smithy.api#documentation": "A list of the inline policies embedded in the group.
" } }, "AttachedManagedPolicies": { "target": "com.amazonaws.iam#attachedPoliciesListType", "traits": { "smithy.api#documentation": "A list of the managed policies attached to the group.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM group, including all of the group's policies.
\nThis data type is used as a response element in the GetAccountAuthorizationDetails operation.
" } }, "com.amazonaws.iam#InstanceProfile": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the instance profile. For more information about paths, see IAM\n identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name identifying the instance profile.
", "smithy.api#required": {} } }, "InstanceProfileId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the instance profile. For more information\n about IDs, see IAM identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) specifying the instance profile. For more information\n about ARNs and how to use them in policies, see IAM identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date when the instance profile was created.
", "smithy.api#required": {} } }, "Roles": { "target": "com.amazonaws.iam#roleListType", "traits": { "smithy.api#documentation": "The role associated with the instance profile.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an instance profile.
\nThis data type is used as a response element in the following operations:
\n\n GetInstanceProfile\n
\n\n ListInstanceProfiles\n
\nThe request was rejected because the authentication code was not recognized. The error\n message describes the specific error.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.iam#InvalidCertificateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#invalidCertificateMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the certificate is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#InvalidInputException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#invalidInputMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#InvalidPublicKeyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#invalidPublicKeyMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the public key is malformed or otherwise invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#InvalidUserTypeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#invalidUserTypeMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the type of user for the transaction was\n incorrect.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#KeyPairMismatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#keyPairMismatchMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the public key certificate and the private key do not\n match.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#limitExceededMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current AWS\n account limits. The error message describes the limit exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#LineNumber": { "type": "integer" }, "com.amazonaws.iam#ListAccessKeys": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListAccessKeysRequest" }, "output": { "target": "com.amazonaws.iam#ListAccessKeysResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Returns information about the access key IDs associated with the specified IAM user.\n If there is none, the operation returns an empty list.
\nAlthough each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems
and Marker
parameters.
If the UserName
field is not specified, the user name is determined\n implicitly based on the AWS access key ID used to sign the request. This operation\n works for access keys under the AWS account. Consequently, you can use this operation\n to manage AWS account root user credentials even if the AWS account has no\n associated users.
To ensure the security of your AWS account, the secret access key is accessible\n only during key and user creation.
\nThe name of the user.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of objects containing metadata about the access keys.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListAccessKeys request.\n
" } }, "com.amazonaws.iam#ListAccountAliases": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListAccountAliasesRequest" }, "output": { "target": "com.amazonaws.iam#ListAccountAliasesResponse" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the account alias associated with the AWS account (Note: you can have only\n one). For information about using an AWS account alias, see Using an alias for your\n AWS account ID in the IAM User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "AccountAliases", "pageSize": "MaxItems" } } }, "com.amazonaws.iam#ListAccountAliasesRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of aliases associated with the account. AWS supports only one alias per\n account.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListAccountAliases request.\n
" } }, "com.amazonaws.iam#ListAttachedGroupPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListAttachedGroupPoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListAttachedGroupPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists all managed policies that are attached to the specified IAM group.
\nAn IAM group can also have inline policies embedded with it. To list the inline\n policies for a group, use ListGroupPolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. You can use the PathPrefix
parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified group (or none that match the specified path prefix), the\n operation returns an empty list.
The name (friendly name, not ARN) of the group to list attached policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PathPrefix": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of the attached policies.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListAttachedGroupPolicies\n request.
" } }, "com.amazonaws.iam#ListAttachedRolePolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListAttachedRolePoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListAttachedRolePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists all managed policies that are attached to the specified IAM role.
\nAn IAM role can also have inline policies embedded with it. To list the inline\n policies for a role, use ListRolePolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. You can use the PathPrefix
parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified role (or none that match the specified path prefix), the\n operation returns an empty list.
The name (friendly name, not ARN) of the role to list attached policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PathPrefix": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of the attached policies.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListAttachedRolePolicies\n request.
" } }, "com.amazonaws.iam#ListAttachedUserPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListAttachedUserPoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListAttachedUserPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists all managed policies that are attached to the specified IAM user.
\nAn IAM user can also have inline policies embedded with it. To list the inline\n policies for a user, use ListUserPolicies. For information about\n policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. You can use the PathPrefix
parameter to limit the list of\n policies to only those matching the specified path prefix. If there are no policies\n attached to the specified group (or none that match the specified path prefix), the\n operation returns an empty list.
The name (friendly name, not ARN) of the user to list attached policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PathPrefix": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of the attached policies.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListAttachedUserPolicies\n request.
" } }, "com.amazonaws.iam#ListEntitiesForPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListEntitiesForPolicyRequest" }, "output": { "target": "com.amazonaws.iam#ListEntitiesForPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists all IAM users, groups, and roles that the specified managed policy is attached\n to.
\nYou can use the optional EntityFilter
parameter to limit the results to a\n particular type of entity (users, groups, or roles). For example, to list only the roles\n that are attached to the specified policy, set EntityFilter
to\n Role
.
You can paginate the results using the MaxItems
and Marker
\n parameters.
The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "EntityFilter": { "target": "com.amazonaws.iam#EntityType", "traits": { "smithy.api#documentation": "The entity type to use for filtering the results.
\nFor example, when EntityFilter
is Role
, only the roles that\n are attached to the specified policy are returned. This parameter is optional. If it is\n not included, all attached entities (users, groups, and roles) are returned. The\n 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\n included, it defaults to a slash (/), listing all entities.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The policy usage method to use for filtering the results.
\nTo list only permissions policies,\n set PolicyUsageFilter
to PermissionsPolicy
. To list only\n the policies used to set permissions boundaries, set the value\n to PermissionsBoundary
.
This parameter is optional. If it is not included, all policies are returned.
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of IAM groups that the policy is attached to.
" } }, "PolicyUsers": { "target": "com.amazonaws.iam#PolicyUserListType", "traits": { "smithy.api#documentation": "A list of IAM users that the policy is attached to.
" } }, "PolicyRoles": { "target": "com.amazonaws.iam#PolicyRoleListType", "traits": { "smithy.api#documentation": "A list of IAM roles that the policy is attached to.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListEntitiesForPolicy request.\n
" } }, "com.amazonaws.iam#ListGroupPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListGroupPoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListGroupPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the names of the inline policies that are embedded in the specified IAM\n group.
\nAn IAM group can also have managed policies attached to it. To list the managed\n policies that are attached to a group, use ListAttachedGroupPolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. If there are no inline policies embedded with the specified group, the\n operation returns an empty list.
The name of the group to list policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of policy names.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListGroupPolicies request.\n
" } }, "com.amazonaws.iam#ListGroups": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListGroupsRequest" }, "output": { "target": "com.amazonaws.iam#ListGroupsResponse" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the IAM groups that have the specified path prefix.
\n You can paginate the results using the MaxItems
and Marker
\n parameters.
Lists the IAM groups that the specified IAM user belongs to.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The name of the user to list groups for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of groups.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListGroupsForUser request.\n
" } }, "com.amazonaws.iam#ListGroupsRequest": { "type": "structure", "members": { "PathPrefix": { "target": "com.amazonaws.iam#pathPrefixType", "traits": { "smithy.api#documentation": " The path prefix for filtering the results. For example, the prefix\n /division_abc/subdivision_xyz/
gets all groups whose path starts with\n /division_abc/subdivision_xyz/
.
This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all groups. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of groups.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListGroups request.
" } }, "com.amazonaws.iam#ListInstanceProfileTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListInstanceProfileTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListInstanceProfileTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListInstanceProfileTagsRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the IAM instance profile whose tags you want to see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the instance profiles that have the specified path prefix. If there are none,\n the operation returns an empty list. For more information about instance profiles, see\n About\n instance profiles.
\nIAM resource-listing operations return a subset of the available \n 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.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
Lists the instance profiles that have the specified associated IAM role. If there\n are none, the operation returns an empty list. For more information about instance\n profiles, go to About instance\n profiles.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The name of the role to list instance profiles for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of instance profiles.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListInstanceProfilesForRole\n request.
" } }, "com.amazonaws.iam#ListInstanceProfilesRequest": { "type": "structure", "members": { "PathPrefix": { "target": "com.amazonaws.iam#pathPrefixType", "traits": { "smithy.api#documentation": " The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/
gets all instance profiles whose path\n starts with /application_abc/component_xyz/
.
This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of instance profiles.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListInstanceProfiles request.\n
" } }, "com.amazonaws.iam#ListMFADeviceTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListMFADeviceTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListMFADeviceTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListMFADeviceTagsRequest": { "type": "structure", "members": { "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The unique identifier for the IAM virtual MFA device whose tags you want to see.\n For virtual MFA devices, the serial number is the same as the ARN.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the MFA devices for an IAM user. If the request includes a IAM user name,\n then this operation lists all the MFA devices associated with the specified user. If you\n do not specify a user name, IAM determines the user name implicitly based on the AWS\n access key ID signing the request for this operation.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The name of the user whose MFA devices you want to list.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of MFA devices.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListMFADevices request.\n
" } }, "com.amazonaws.iam#ListOpenIDConnectProviderTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListOpenIDConnectProviderTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListOpenIDConnectProviderTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible\n identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity\n federation.
\nFor more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListOpenIDConnectProviderTagsRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the OpenID Connect (OIDC) identity provider whose tags you want to\n see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
The list of tags that are currently attached to the OpenID Connect (OIDC) identity\n 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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists information about the IAM OpenID Connect (OIDC) provider resource objects\n defined in the AWS account.
\nIAM resource-listing operations return a subset of the available \n 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.
\nThe list of IAM OIDC provider resource objects defined in the AWS account.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful ListOpenIDConnectProviders\n request.
" } }, "com.amazonaws.iam#ListPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListPoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists all the managed policies that are available in your AWS account, including\n your own customer-defined managed policies and all AWS managed policies.
\nYou can filter the list of policies that is returned using the optional\n OnlyAttached
, Scope
, and PathPrefix
\n parameters. For example, to list only the customer managed policies in your AWS\n account, set Scope
to Local
. To list only AWS managed\n policies, set Scope
to AWS
.
You can paginate the results using the MaxItems
and Marker
\n parameters.
For more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.
\nIAM resource-listing operations return a subset of the available \n 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\n GetPolicy.
\nRetrieves a list of policies that the IAM identity (user, group, or role) can use to\n access each specified service.
\nThis operation does not use other policy types when determining whether a resource\n could access a service. These other policy types include resource-based policies,\n access control lists, AWS Organizations policies, IAM permissions boundaries, and\n AWS STS assume role policies. It only applies permissions policy logic. For more\n about the evaluation of policy types, see Evaluating policies in the\n IAM User Guide.
\nThe list of policies returned by the operation depends on the ARN of the identity that\n you provide.
\n\n User – The list of policies includes\n the managed and inline policies that are attached to the user directly. The list\n also includes any additional managed and inline policies that are attached to\n the group to which the user belongs.
\n\n Group – The list of policies includes\n only the managed and inline policies that are attached to the group directly.\n Policies that are attached to the group’s user are not included.
\n\n Role – The list of policies includes\n only the managed and inline policies that are attached to the role.
\nFor each managed policy, this operation returns the ARN and policy name. For each\n inline policy, it returns the policy name and the entity to which it is attached. Inline\n policies do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the\n IAM User Guide.
\nPolicies that are attached to users and roles as permissions boundaries are not\n returned. To view which managed policy is currently used to set the permissions boundary\n for a user or role, use the GetUser or GetRole\n operations.
" } }, "com.amazonaws.iam#ListPoliciesGrantingServiceAccessEntry": { "type": "structure", "members": { "ServiceNamespace": { "target": "com.amazonaws.iam#serviceNamespaceType", "traits": { "smithy.api#documentation": "The namespace of the service that was accessed.
\nTo learn the service namespace of a service, see Actions, resources, and condition keys for AWS services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b)
. For more information about service namespaces,\n see AWS\n service namespaces in the AWS General Reference.
The PoliciesGrantingServiceAccess
object that contains details about the\n policy.
Contains details about the permissions policies that are attached to the specified\n identity (user, group, or role).
\nThis data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.
" } }, "com.amazonaws.iam#ListPoliciesGrantingServiceAccessRequest": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The ARN of the IAM identity (user, group, or role) whose policies you want to\n list.
", "smithy.api#required": {} } }, "ServiceNamespaces": { "target": "com.amazonaws.iam#serviceNamespaceListType", "traits": { "smithy.api#documentation": "The service namespace for the AWS services whose policies you want to list.
\nTo learn the service namespace for a service, see Actions, resources, and condition keys for AWS services in the\n IAM User Guide. Choose the name of the service to view\n details for that service. In the first paragraph, find the service prefix. For example,\n (service prefix: a4b)
. For more information about service namespaces,\n see AWS\n service namespaces in the AWS General Reference.
A ListPoliciesGrantingServiceAccess
object that contains details about\n the permissions policies attached to the specified identity (user, group, or\n role).
A flag that indicates whether there are more items to return. If your results were\n truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. We recommend that you check\n IsTruncated
after every call to ensure that you receive all your\n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
The scope to use for filtering the results.
\nTo list only AWS managed policies, set Scope
to AWS
. To\n list only the customer managed policies in your AWS account, set Scope
to\n Local
.
This parameter is optional. If it is not included, or if it is set to\n All
, all policies are returned.
A flag to filter the results to only the attached policies.
\nWhen OnlyAttached
is true
, the returned list contains only\n the policies that are attached to an IAM user, group, or role. When\n OnlyAttached
is false
, or when the parameter is not\n included, all policies are returned.
The path prefix for filtering the results. This parameter is optional. If it is not\n included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The policy usage method to use for filtering the results.
\nTo list only permissions policies,\n set PolicyUsageFilter
to PermissionsPolicy
. To list only\n the policies used to set permissions boundaries, set the value\n to PermissionsBoundary
.
This parameter is optional. If it is not included, all policies are returned.
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of policies.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListPolicies request.\n
" } }, "com.amazonaws.iam#ListPolicyTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListPolicyTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListPolicyTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified IAM customer managed policy.\n The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListPolicyTagsRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the IAM customer managed policy whose tags you want to see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
The list of tags that are currently attached to the IAM customer managed policy.\n 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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists information about the versions of the specified managed policy, including the\n version that is currently set as the policy's default version.
\nFor more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Versions", "pageSize": "MaxItems" } } }, "com.amazonaws.iam#ListPolicyVersionsRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy for which you want the\n versions.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of policy versions.
\nFor more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListPolicyVersions request.\n
" } }, "com.amazonaws.iam#ListRolePolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListRolePoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListRolePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the names of the inline policies that are embedded in the specified IAM\n role.
\nAn IAM role can also have managed policies attached to it. To list the managed\n policies that are attached to a role, use ListAttachedRolePolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. If there are no inline policies embedded with the specified role, the\n operation returns an empty list.
The name of the role to list policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of policy names.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListRolePolicies request.\n
" } }, "com.amazonaws.iam#ListRoleTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListRoleTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListRoleTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified role. The returned list of tags is\n sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListRoleTagsRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the IAM role for which you want to see the list of tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the IAM roles that have the specified path prefix. If there are none, the\n operation returns an empty list. For more information about roles, see Working with\n roles.
\nIAM resource-listing operations return a subset of the available \n 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.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The path prefix for filtering the results. For example, the prefix\n /application_abc/component_xyz/
gets all roles whose path starts with\n /application_abc/component_xyz/
.
This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all roles. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of roles.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListRoles request.
" } }, "com.amazonaws.iam#ListSAMLProviderTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListSAMLProviderTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListSAMLProviderTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified Security Assertion Markup Language\n (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based\n federation.
\nFor more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#ListSAMLProviderTagsRequest": { "type": "structure", "members": { "SAMLProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the Security Assertion Markup Language (SAML) identity provider whose tags\n you want to see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
The list of tags that are currently attached to the Security Assertion Markup Language\n (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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the SAML provider resource objects defined in IAM in the account.\n IAM resource-listing operations return a subset of the available \n 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.
\nThis operation requires Signature Version 4.
\nThe list of SAML provider resource objects defined in IAM for this AWS\n account.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful ListSAMLProviders request.\n
" } }, "com.amazonaws.iam#ListSSHPublicKeys": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListSSHPublicKeysRequest" }, "output": { "target": "com.amazonaws.iam#ListSSHPublicKeysResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Returns information about the SSH public keys associated with the specified IAM\n user. If none exists, the operation returns an empty list.
\nThe SSH public keys returned by this operation are used only for authenticating the\n IAM user to an AWS CodeCommit repository. For more information about using SSH keys to\n authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for\n SSH connections in the AWS CodeCommit User Guide.
\nAlthough each user is limited to a small number of keys, you can still paginate the\n results using the MaxItems
and Marker
parameters.
The name of the IAM user to list SSH public keys for. If none is specified, the\n UserName
field is determined implicitly based on the AWS access key\n used to sign the request.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of the SSH public keys assigned to IAM user.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListSSHPublicKeys\n request.
" } }, "com.amazonaws.iam#ListServerCertificateTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListServerCertificateTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListServerCertificateTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified IAM server certificate. The\n returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nFor certificates in a Region supported by AWS Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.
\nThe name of the IAM server certificate whose tags you want to see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
The list of tags that are currently attached to the IAM server certificate.\n 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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the server certificates stored in IAM that have the specified path prefix. If\n none exist, the operation returns an empty list.
\n You can paginate the results using the MaxItems
and Marker
\n parameters.
For more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of AWS services that can use the server certificates that\n you manage with IAM.
\nIAM resource-listing operations return a subset of the available \n 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.
\n The path prefix for filtering the results. For example:\n /company/servercerts
would get all server certificates for which the\n path starts with /company/servercerts
.
This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all server certificates. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of server certificates.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListServerCertificates request.\n
" } }, "com.amazonaws.iam#ListServiceSpecificCredentials": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListServiceSpecificCredentialsRequest" }, "output": { "target": "com.amazonaws.iam#ListServiceSpecificCredentialsResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceNotSupportedException" } ], "traits": { "smithy.api#documentation": "Returns information about the service-specific credentials associated with the\n specified IAM user. If none exists, the operation returns an empty list. The\n service-specific credentials returned by this operation are used only for authenticating\n the IAM user to a specific service. For more information about using service-specific\n credentials to authenticate to an AWS service, see Set up service-specific credentials\n in the AWS CodeCommit User Guide.
" } }, "com.amazonaws.iam#ListServiceSpecificCredentialsRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the user whose service-specific credentials you want information about. If\n this value is not specified, then the operation assumes the user whose credentials are\n used to call the operation.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "ServiceName": { "target": "com.amazonaws.iam#serviceName", "traits": { "smithy.api#documentation": "Filters the returned results to only those for the specified AWS service. If not\n specified, then AWS returns service-specific credentials for all services.
" } } } }, "com.amazonaws.iam#ListServiceSpecificCredentialsResponse": { "type": "structure", "members": { "ServiceSpecificCredentials": { "target": "com.amazonaws.iam#ServiceSpecificCredentialsListType", "traits": { "smithy.api#documentation": "A list of structures that each contain details about a service-specific\n credential.
" } } } }, "com.amazonaws.iam#ListSigningCertificates": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListSigningCertificatesRequest" }, "output": { "target": "com.amazonaws.iam#ListSigningCertificatesResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Returns information about the signing certificates associated with the specified IAM\n user. If none exists, the operation returns an empty list.
\nAlthough each user is limited to a small number of signing certificates, you can still\n paginate the results using the MaxItems
and Marker
\n parameters.
If the UserName
field is not specified, the user name is determined\n implicitly based on the AWS access key ID used to sign the request for this operation.\n This operation works for access keys under the AWS account. Consequently, you can use\n this operation to manage AWS account root user credentials even if the AWS account\n has no associated users.
The name of the IAM user whose signing certificates you want to examine.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of the user's signing certificate information.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListSigningCertificates\n request.
" } }, "com.amazonaws.iam#ListUserPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListUserPoliciesRequest" }, "output": { "target": "com.amazonaws.iam#ListUserPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the names of the inline policies embedded in the specified IAM user.
\nAn IAM user can also have managed policies attached to it. To list the managed\n policies that are attached to a user, use ListAttachedUserPolicies.\n For more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters. If there are no inline policies embedded with the specified user, the\n operation returns an empty list.
The name of the user to list policies for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of policy names.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListUserPolicies request.\n
" } }, "com.amazonaws.iam#ListUserTags": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListUserTagsRequest" }, "output": { "target": "com.amazonaws.iam#ListUserTagsResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "com.amazonaws.iam#ListUserTagsRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the IAM user whose tags you want to see.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
(Optional) Use this only when paginating results to indicate the \n maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated
response element is true
.
If you do not include this parameter, it defaults to 100. Note that\n IAM might return fewer results, even when more results are available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
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.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can use the Marker
request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the \n MaxItems
number of results even when more results are available. Check IsTruncated
after every call to ensure that you receive all of your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Lists the IAM users that have the specified path prefix. If no path prefix is\n specified, the operation returns all users in the AWS account. If there are none, the\n operation returns an empty list.
\nIAM resource-listing operations return a subset of the available \n 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.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The path prefix for filtering the results. For example:\n /division_abc/subdivision_xyz/
, which would get all user names whose\n path starts with /division_abc/subdivision_xyz/
.
This parameter is optional. If it is not included, it defaults to a slash (/), listing\n all user names. This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
A list of users.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful ListUsers request.
" } }, "com.amazonaws.iam#ListVirtualMFADevices": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListVirtualMFADevicesRequest" }, "output": { "target": "com.amazonaws.iam#ListVirtualMFADevicesResponse" }, "traits": { "smithy.api#documentation": "Lists the virtual MFA devices defined in the AWS account by assignment status. If\n you do not specify an assignment status, the operation returns a list of all virtual MFA\n devices. Assignment status can be Assigned
, Unassigned
, or\n Any
.
IAM resource-listing operations return a subset of the available \n 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 virtual MFA device, see\n ListVirtualMFADevices.
\nYou can paginate the results using the MaxItems
and Marker
\n parameters.
The status (Unassigned
or Assigned
) of the devices to list.\n If you do not specify an AssignmentStatus
, the operation defaults to\n Any
, which lists both assigned and unassigned virtual MFA\n devices.,
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
Use this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
The list of virtual MFA devices in the current account that match the\n AssignmentStatus
value that was passed in the request.
A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element is present and\n contains the value to use for the Marker
parameter in a subsequent\n pagination request.
Contains the response to a successful ListVirtualMFADevices request.\n
" } }, "com.amazonaws.iam#LoginProfile": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the user, which can be used for signing in to the AWS Management\n Console.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date when the password for the user was created.
", "smithy.api#required": {} } }, "PasswordResetRequired": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether the user is required to set a new password on next sign-in.
" } } }, "traits": { "smithy.api#documentation": "Contains the user name and password create date for a user.
\nThis data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.
" } }, "com.amazonaws.iam#MFADevice": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The user with whom the MFA device is associated.
", "smithy.api#required": {} } }, "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n serial number is the device ARN.
", "smithy.api#required": {} } }, "EnableDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date when the MFA device was enabled for the user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about an MFA device.
\nThis data type is used as a response element in the ListMFADevices\n operation.
" } }, "com.amazonaws.iam#MalformedCertificateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#malformedCertificateMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the certificate was malformed or expired. The error\n message describes the specific error.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#MalformedPolicyDocumentException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#malformedPolicyDocumentMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the policy document was malformed. The error message\n describes the specific error.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#ManagedPolicyDetail": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The friendly name (not ARN) identifying the policy.
" } }, "PolicyId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the policy.
\nFor more information about IDs, see IAM identifiers in the\n IAM User Guide.
" } }, "Arn": { "target": "com.amazonaws.iam#arnType" }, "Path": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path to the policy.
\nFor more information about paths, see IAM identifiers in the\n IAM User Guide.
" } }, "DefaultVersionId": { "target": "com.amazonaws.iam#policyVersionIdType", "traits": { "smithy.api#documentation": "The identifier for the version of the policy that is set as the default (operative)\n version.
\nFor more information about policy versions, see Versioning for managed\n policies in the IAM User Guide.
" } }, "AttachmentCount": { "target": "com.amazonaws.iam#attachmentCountType", "traits": { "smithy.api#documentation": "The number of principal entities (users, groups, and roles) that the policy is attached\n to.
" } }, "PermissionsBoundaryUsageCount": { "target": "com.amazonaws.iam#attachmentCountType", "traits": { "smithy.api#documentation": "The number of entities (users and roles) for which the policy is used as the permissions\n boundary.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "IsAttachable": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether the policy can be attached to an IAM user, group, or role.
" } }, "Description": { "target": "com.amazonaws.iam#policyDescriptionType", "traits": { "smithy.api#documentation": "A friendly description of the policy.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the policy was created.
" } }, "UpdateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the policy was last updated.
\nWhen a policy has only one version, this field contains the date and time when the\n policy was created. When a policy has more than one version, this field contains the date\n and time when the most recent policy version was created.
" } }, "PolicyVersionList": { "target": "com.amazonaws.iam#policyDocumentVersionListType", "traits": { "smithy.api#documentation": "A list containing information about the versions of the policy.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a managed policy, including the policy's ARN, versions, and\n the number of principal entities (users, groups, and roles) that the policy is attached\n to.
\nThis data type is used as a response element in the GetAccountAuthorizationDetails operation.
\nFor more information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#ManagedPolicyDetailListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ManagedPolicyDetail" } }, "com.amazonaws.iam#NoSuchEntityException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#noSuchEntityMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because it referenced a resource entity that does not exist. The\n error message describes the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iam#OpenIDConnectProviderListEntry": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.iam#arnType" } }, "traits": { "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
" } }, "com.amazonaws.iam#OpenIDConnectProviderListType": { "type": "list", "member": { "target": "com.amazonaws.iam#OpenIDConnectProviderListEntry" }, "traits": { "smithy.api#documentation": "Contains a list of IAM OpenID Connect providers.
" } }, "com.amazonaws.iam#OpenIDConnectProviderUrlType": { "type": "string", "traits": { "smithy.api#documentation": "Contains a URL that specifies the endpoint for an OpenID Connect provider.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.iam#OrganizationsDecisionDetail": { "type": "structure", "members": { "AllowedByOrganizations": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether the simulated operation is allowed by the Organizations service control\n policies that impact the simulated user's account.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the effect that Organizations has on a policy simulation.
" } }, "com.amazonaws.iam#PasswordPolicy": { "type": "structure", "members": { "MinimumPasswordLength": { "target": "com.amazonaws.iam#minimumPasswordLengthType", "traits": { "smithy.api#documentation": "Minimum length to require for IAM user passwords.
" } }, "RequireSymbols": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one of the following symbols:
\n! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
" } }, "RequireNumbers": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
" } }, "RequireUppercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).
" } }, "RequireLowercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
" } }, "AllowUsersToChangePassword": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether IAM users are allowed to change their own password.
" } }, "ExpirePasswords": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Indicates whether passwords in the account expire. Returns true if\n MaxPasswordAge
contains a value greater than 0. Returns false if\n MaxPasswordAge is 0 or not present.
The number of days that an IAM user password is valid.
" } }, "PasswordReusePrevention": { "target": "com.amazonaws.iam#passwordReusePreventionType", "traits": { "smithy.api#documentation": "Specifies the number of previous passwords that IAM users are prevented from\n reusing.
" } }, "HardExpiry": { "target": "com.amazonaws.iam#booleanObjectType", "traits": { "smithy.api#documentation": "Specifies whether IAM users are prevented from setting a new password after their\n password has expired.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the account password policy.
\nThis data type is used as a response element in the GetAccountPasswordPolicy operation.
" } }, "com.amazonaws.iam#PasswordPolicyViolationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#passwordPolicyViolationMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the provided password did not meet the requirements\n imposed by the account password policy.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#PermissionsBoundaryAttachmentType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PermissionsBoundaryPolicy", "name": "Policy" } ] } }, "com.amazonaws.iam#PermissionsBoundaryDecisionDetail": { "type": "structure", "members": { "AllowedByPermissionsBoundary": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether an action is allowed by a permissions boundary that is applied to an\n IAM entity (user or role). A value of true
means that the permissions\n boundary does not deny the action. This means that the policy includes an\n Allow
statement that matches the request. In this case, if an\n identity-based policy also allows the action, the request is allowed. A value of\n false
means that either the requested action is not allowed (implicitly\n denied) or that the action is explicitly denied by the permissions boundary. In both of\n these cases, the action is not allowed, regardless of the identity-based policy.
Contains information about the effect that a permissions boundary has on a policy\n simulation when the boundary is applied to an IAM entity.
" } }, "com.amazonaws.iam#Policy": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The friendly name (not ARN) identifying the policy.
" } }, "PolicyId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the policy.
\nFor more information about IDs, see IAM identifiers in the\n IAM User Guide.
" } }, "Arn": { "target": "com.amazonaws.iam#arnType" }, "Path": { "target": "com.amazonaws.iam#policyPathType", "traits": { "smithy.api#documentation": "The path to the policy.
\nFor more information about paths, see IAM identifiers in the\n IAM User Guide.
" } }, "DefaultVersionId": { "target": "com.amazonaws.iam#policyVersionIdType", "traits": { "smithy.api#documentation": "The identifier for the version of the policy that is set as the default version.
" } }, "AttachmentCount": { "target": "com.amazonaws.iam#attachmentCountType", "traits": { "smithy.api#documentation": "The number of entities (users, groups, and roles) that the policy is attached to.
" } }, "PermissionsBoundaryUsageCount": { "target": "com.amazonaws.iam#attachmentCountType", "traits": { "smithy.api#documentation": "The number of entities (users and roles) for which the policy is used to set the\n permissions boundary.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "IsAttachable": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "Specifies whether the policy can be attached to an IAM user, group, or role.
" } }, "Description": { "target": "com.amazonaws.iam#policyDescriptionType", "traits": { "smithy.api#documentation": "A friendly description of the policy.
\nThis element is included in the response to the GetPolicy operation.\n It is not included in the response to the ListPolicies operation.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the policy was created.
" } }, "UpdateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the policy was last updated.
\nWhen a policy has only one version, this field contains the date and time when the\n policy was created. When a policy has more than one version, this field contains the date\n and time when the most recent policy version was created.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a managed policy.
\nThis data type is used as a response element in the CreatePolicy,\n GetPolicy, and ListPolicies operations.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#PolicyDetail": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy.
" } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM policy, including the policy document.
\nThis data type is used as a response element in the GetAccountAuthorizationDetails operation.
" } }, "com.amazonaws.iam#PolicyEvaluationDecisionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "allowed", "name": "ALLOWED" }, { "value": "explicitDeny", "name": "EXPLICIT_DENY" }, { "value": "implicitDeny", "name": "IMPLICIT_DENY" } ] } }, "com.amazonaws.iam#PolicyEvaluationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#policyEvaluationErrorMessage" } }, "traits": { "smithy.api#documentation": "The request failed because a provided policy could not be successfully evaluated. An\n additional detailed message indicates the source of the failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iam#PolicyGrantingServiceAccess": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The policy name.
", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.iam#policyType", "traits": { "smithy.api#documentation": "The policy type. For more information about these policy types, see Managed\n policies and inline policies in the\n IAM User Guide.
", "smithy.api#required": {} } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType" }, "EntityType": { "target": "com.amazonaws.iam#policyOwnerEntityType", "traits": { "smithy.api#documentation": "The type of entity (user or role) that used the policy to access the service to which\n the inline policy is attached.
\nThis field is null for managed policies. For more information about these policy types,\n see Managed policies and inline policies in the\n IAM User Guide.
" } }, "EntityName": { "target": "com.amazonaws.iam#entityNameType", "traits": { "smithy.api#documentation": "The name of the entity (user or role) to which the inline policy is attached.
\nThis field is null for managed policies. For more information about these policy types,\n see Managed policies and inline policies in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the permissions policies that are attached to the specified\n identity (user, group, or role).
\nThis data type is an element of the ListPoliciesGrantingServiceAccessEntry object.
" } }, "com.amazonaws.iam#PolicyGroup": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the group.
" } }, "GroupId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the group. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a group that a managed policy is attached to.
\nThis data type is used as a response element in the ListEntitiesForPolicy operation.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#PolicyGroupListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyGroup" } }, "com.amazonaws.iam#PolicyIdentifierType": { "type": "string" }, "com.amazonaws.iam#PolicyNotAttachableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#policyNotAttachableMessage" } }, "traits": { "smithy.api#documentation": "The request failed because AWS service role policies can only be attached to the\n service-linked role for that service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#PolicyRole": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the role.
" } }, "RoleId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a role that a managed policy is attached to.
\nThis data type is used as a response element in the ListEntitiesForPolicy operation.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#PolicyRoleListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyRole" } }, "com.amazonaws.iam#PolicySourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "user", "name": "USER" }, { "value": "group", "name": "GROUP" }, { "value": "role", "name": "ROLE" }, { "value": "aws-managed", "name": "AWS_MANAGED" }, { "value": "user-managed", "name": "USER_MANAGED" }, { "value": "resource", "name": "RESOURCE" }, { "value": "none", "name": "NONE" } ] } }, "com.amazonaws.iam#PolicyUsageType": { "type": "string", "traits": { "smithy.api#documentation": "The policy usage type that indicates whether the policy is used as a permissions policy\n or as the permissions boundary for an entity.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
", "smithy.api#enum": [ { "value": "PermissionsPolicy", "name": "PermissionsPolicy" }, { "value": "PermissionsBoundary", "name": "PermissionsBoundary" } ] } }, "com.amazonaws.iam#PolicyUser": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) identifying the user.
" } }, "UserId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a user that a managed policy is attached to.
\nThis data type is used as a response element in the ListEntitiesForPolicy operation.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#PolicyUserListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyUser" } }, "com.amazonaws.iam#PolicyVersion": { "type": "structure", "members": { "Document": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nThe policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in\n the response to the CreatePolicyVersion or ListPolicyVersions operations.
\nThe policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding\n method to convert the policy back to plain JSON text. For example, if you use Java, you can\n use the decode
method of the java.net.URLDecoder
utility class in\n the Java SDK. Other languages and SDKs provide similar functionality.
The identifier for the policy version.
\nPolicy version identifiers always begin with v
(always lowercase). When a\n policy is created, the first policy version is v1
.
Specifies whether the policy version is set as the policy's default version.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the policy version was created.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a version of a managed policy.
\nThis data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.
\nFor more information about managed policies, refer to Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#Position": { "type": "structure", "members": { "Line": { "target": "com.amazonaws.iam#LineNumber", "traits": { "smithy.api#documentation": "The line containing the specified position in the document.
" } }, "Column": { "target": "com.amazonaws.iam#ColumnNumber", "traits": { "smithy.api#documentation": "The column in the line containing the specified position in the document.
" } } }, "traits": { "smithy.api#documentation": "Contains the row and column of a location of a Statement
element in a\n policy document.
This data type is used as a member of the \n Statement\n
type.
Adds or updates an inline policy document that is embedded in the specified IAM\n group.
\nA user can also have managed policies attached to it. To attach a managed policy to a\n group, use AttachGroupPolicy. To create a new managed policy, use\n CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
\nFor information about the maximum number of inline policies that you can embed in a\n group, see IAM and STS quotas in the IAM User Guide.
\nBecause policy documents can be large, you should use POST rather than GET when\n calling PutGroupPolicy
. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.
The name of the group to associate the policy with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Adds or updates the policy that is specified as the IAM role's permissions boundary.\n You can use an AWS managed policy or a customer managed policy to set the boundary for\n a role. Use the boundary to control the maximum permissions that the role can have.\n Setting a permissions boundary is an advanced feature that can affect the permissions\n for the role.
\nYou cannot set the boundary for a service-linked role.
\nPolicies used as permissions boundaries do not provide permissions. You must also\n attach a permissions policy to the role. To learn how the effective permissions for\n a role are evaluated, see IAM JSON policy\n evaluation logic in the IAM User Guide.
\nThe name (friendly name, not ARN) of the IAM role for which you want to set the\n permissions boundary.
", "smithy.api#required": {} } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the policy that is used to set the permissions boundary for the\n role.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#PutRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#PutRolePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Adds or updates an inline policy document that is embedded in the specified IAM\n role.
\nWhen you embed an inline policy in a role, the inline policy is used as part of the\n role's access (permissions) policy. The role's trust policy is created at the same time\n as the role, using CreateRole. You can update a role's trust policy\n using UpdateAssumeRolePolicy. For more information about IAM roles,\n see Using roles to\n delegate permissions and federate identities.
\nA role can also have a managed policy attached to it. To attach a managed policy to a\n role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
\nFor information about the maximum number of inline policies that you can embed with a\n role, see IAM and STS quotas in the IAM User Guide.
\nBecause policy documents can be large, you should use POST rather than GET when\n calling PutRolePolicy
. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.
The name of the role to associate the policy with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Adds or updates the policy that is specified as the IAM user's permissions boundary.\n You can use an AWS managed policy or a customer managed policy to set the boundary for\n a user. Use the boundary to control the maximum permissions that the user can have.\n Setting a permissions boundary is an advanced feature that can affect the permissions\n for the user.
\nPolicies that are used as permissions boundaries do not provide permissions. You\n must also attach a permissions policy to the user. To learn how the effective\n permissions for a user are evaluated, see IAM JSON policy\n evaluation logic in the IAM User Guide.
\nThe name (friendly name, not ARN) of the IAM user for which you want to set the\n permissions boundary.
", "smithy.api#required": {} } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the policy that is used to set the permissions boundary for the\n user.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#PutUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#PutUserPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds or updates an inline policy document that is embedded in the specified IAM\n user.
\nAn IAM user can also have a managed policy attached to it. To attach a managed\n policy to a user, use AttachUserPolicy. To create a new managed\n policy, use CreatePolicy. For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
\nFor information about the maximum number of inline policies that you can embed in a\n user, see IAM and STS quotas in the IAM User Guide.
\nBecause policy documents can be large, you should use POST rather than GET when\n calling PutUserPolicy
. For general information about using the Query\n API with IAM, see Making query requests in the\n IAM User Guide.
The name of the user to associate the policy with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the policy document.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy document.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Removes the specified client ID (also known as audience) from the list of client IDs\n registered for the specified IAM OpenID Connect (OIDC) provider resource\n object.
\nThis operation is idempotent; it does not fail or return an error if you try to remove\n a client ID that does not exist.
" } }, "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the\n client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "ClientID": { "target": "com.amazonaws.iam#clientIDType", "traits": { "smithy.api#documentation": "The client ID (also known as audience) to remove from the IAM OIDC provider\n resource. For more information about client IDs, see CreateOpenIDConnectProvider.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#RemoveRoleFromInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Removes the specified IAM role from the specified EC2 instance profile.
\nMake sure that you do not have any Amazon EC2 instances running with the role you\n are about to remove from the instance profile. Removing a role from an instance\n profile that is associated with a running instance might break any applications\n running on the instance.
\nFor more information about IAM roles, see Working with roles. For more\n information about instance profiles, see About instance\n profiles.
" } }, "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the instance profile to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role to remove.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#RemoveUserFromGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#RemoveUserFromGroupRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified user from the specified group.
" } }, "com.amazonaws.iam#RemoveUserFromGroupRequest": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.iam#groupNameType", "traits": { "smithy.api#documentation": "The name of the group to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user to remove.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#ReportContentType": { "type": "blob" }, "com.amazonaws.iam#ReportFormatType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "text/csv", "name": "text_csv" } ] } }, "com.amazonaws.iam#ReportGenerationLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#reportGenerationLimitExceededMessage" } }, "traits": { "smithy.api#documentation": "The request failed because the maximum number of concurrent requests for this account are\n already running.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#ReportStateDescriptionType": { "type": "string" }, "com.amazonaws.iam#ReportStateType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STARTED", "name": "STARTED" }, { "value": "INPROGRESS", "name": "INPROGRESS" }, { "value": "COMPLETE", "name": "COMPLETE" } ] } }, "com.amazonaws.iam#ResetServiceSpecificCredential": { "type": "operation", "input": { "target": "com.amazonaws.iam#ResetServiceSpecificCredentialRequest" }, "output": { "target": "com.amazonaws.iam#ResetServiceSpecificCredentialResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Resets the password for a service-specific credential. The new password is AWS\n generated and cryptographically strong. It cannot be configured by the user. Resetting\n the password immediately invalidates the previous password associated with this\n user.
" } }, "com.amazonaws.iam#ResetServiceSpecificCredentialRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the service-specific credential. If this\n value is not specified, then the operation assumes the user whose credentials are used\n to call the operation.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "The unique identifier of the service-specific credential.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#ResetServiceSpecificCredentialResponse": { "type": "structure", "members": { "ServiceSpecificCredential": { "target": "com.amazonaws.iam#ServiceSpecificCredential", "traits": { "smithy.api#documentation": "A structure with details about the updated service-specific credential, including the\n new password.
\nThis is the only time that you can access the\n password. You cannot recover the password later, but you can reset it again.
\nThe name of the simulated resource, in Amazon Resource Name (ARN) format.
", "smithy.api#required": {} } }, "EvalResourceDecision": { "target": "com.amazonaws.iam#PolicyEvaluationDecisionType", "traits": { "smithy.api#documentation": "The result of the simulation of the simulated API operation on the resource specified in\n EvalResourceName
.
A list of the statements in the input policies that determine the result for this part\n of the simulation. Remember that even if multiple statements allow the operation on the\n resource, if any statement denies that operation, then the explicit\n deny overrides any allow. In addition, the deny statement is the only entry included in the\n result.
" } }, "MissingContextValues": { "target": "com.amazonaws.iam#ContextKeyNamesResultListType", "traits": { "smithy.api#documentation": "A list of context keys that are required by the included input policies but that were\n not provided by one of the input parameters. This list is used when a list of ARNs is\n included in the ResourceArns
parameter instead of \"*\". If you do not specify\n individual resources, by setting ResourceArns
to \"*\" or by not including the\n ResourceArns
parameter, then any missing context values are instead\n included under the EvaluationResults
section. To discover the context keys\n used by a set of policies, you can call GetContextKeysForCustomPolicy or\n GetContextKeysForPrincipalPolicy.
Additional details about the results of the evaluation decision on a single resource.\n This parameter is returned only for cross-account simulations. This parameter explains how\n each policy type contributes to the resource-specific evaluation decision.
" } }, "PermissionsBoundaryDecisionDetail": { "target": "com.amazonaws.iam#PermissionsBoundaryDecisionDetail", "traits": { "smithy.api#documentation": "Contains information about the effect that a permissions boundary has on a policy\n simulation when that boundary is applied to an IAM entity.
" } } }, "traits": { "smithy.api#documentation": "Contains the result of the simulation of a single API operation call on a single\n resource.
\nThis data type is used by a member of the EvaluationResult data\n type.
" } }, "com.amazonaws.iam#ResourceSpecificResultListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ResourceSpecificResult" } }, "com.amazonaws.iam#ResyncMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#ResyncMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidAuthenticationCodeException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Synchronizes the specified MFA device with its IAM resource object on the AWS\n servers.
\nFor more information about creating and working with virtual MFA devices, see Using a virtual MFA\n device in the IAM User Guide.
" } }, "com.amazonaws.iam#ResyncMFADeviceRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user whose MFA device you want to resynchronize.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "Serial number that uniquely identifies the MFA device.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "AuthenticationCode1": { "target": "com.amazonaws.iam#authenticationCodeType", "traits": { "smithy.api#documentation": "An authentication code emitted by the device.
\nThe format for this parameter is a sequence of six digits.
", "smithy.api#required": {} } }, "AuthenticationCode2": { "target": "com.amazonaws.iam#authenticationCodeType", "traits": { "smithy.api#documentation": "A subsequent authentication code emitted by the device.
\nThe format for this parameter is a sequence of six digits.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#Role": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the role. For more information about paths, see IAM identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The friendly name that identifies the role.
", "smithy.api#required": {} } }, "RoleId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and\n how to use them in policies, see IAM identifiers in the\n IAM User Guide guide.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the role was created.
", "smithy.api#required": {} } }, "AssumeRolePolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy that grants an entity permission to assume the role.
" } }, "Description": { "target": "com.amazonaws.iam#roleDescriptionType", "traits": { "smithy.api#documentation": "A description of the role that you provide.
" } }, "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { "smithy.api#documentation": "The maximum session duration (in seconds) for the specified role. Anyone who uses the\n AWS CLI, or API to assume the role can specify the duration using the optional\n DurationSeconds
API parameter or duration-seconds
CLI\n parameter.
The ARN of the policy used to set the permissions boundary for the role.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "RoleLastUsed": { "target": "com.amazonaws.iam#RoleLastUsed", "traits": { "smithy.api#documentation": "Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM User\n Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM role. This structure is returned as a response\n element in several API operations that interact with roles.
" } }, "com.amazonaws.iam#RoleDetail": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the role. For more information about paths, see IAM identifiers in the\n IAM User Guide.
" } }, "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The friendly name that identifies the role.
" } }, "RoleId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the role. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } }, "Arn": { "target": "com.amazonaws.iam#arnType" }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the role was created.
" } }, "AssumeRolePolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The trust policy that grants permission to assume the role.
" } }, "InstanceProfileList": { "target": "com.amazonaws.iam#instanceProfileListType", "traits": { "smithy.api#documentation": "A list of instance profiles that contain this role.
" } }, "RolePolicyList": { "target": "com.amazonaws.iam#policyDetailListType", "traits": { "smithy.api#documentation": "A list of inline policies embedded in the role. These policies are the role's access\n (permissions) policies.
" } }, "AttachedManagedPolicies": { "target": "com.amazonaws.iam#attachedPoliciesListType", "traits": { "smithy.api#documentation": "A list of managed policies attached to the role. These policies are the role's access\n (permissions) policies.
" } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { "smithy.api#documentation": "The ARN of the policy used to set the permissions boundary for the role.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "RoleLastUsed": { "target": "com.amazonaws.iam#RoleLastUsed", "traits": { "smithy.api#documentation": "Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM User\n Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM role, including all of the role's policies.
\nThis data type is used as a response element in the GetAccountAuthorizationDetails operation.
" } }, "com.amazonaws.iam#RoleLastUsed": { "type": "structure", "members": { "LastUsedDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format that the role was last used.
\nThis field is null if the role has not been used within the IAM tracking period. For\n more information about the tracking period, see Regions where data is tracked in the IAM User Guide.
" } }, "Region": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The name of the AWS Region in which the role was last used.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the last time that an IAM role was used. This includes the\n date and time and the Region in which the role was last used. Activity is only reported for\n the trailing 400 days. This period can be shorter if your Region began supporting these\n features within the last year. The role might have been used more than 400 days ago. For\n more information, see Regions where data is tracked in the IAM User\n Guide.
\nThis data type is returned as a response element in the GetRole and\n GetAccountAuthorizationDetails operations.
" } }, "com.amazonaws.iam#RoleUsageListType": { "type": "list", "member": { "target": "com.amazonaws.iam#RoleUsageType" } }, "com.amazonaws.iam#RoleUsageType": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.iam#RegionNameType", "traits": { "smithy.api#documentation": "The name of the Region where the service-linked role is being used.
" } }, "Resources": { "target": "com.amazonaws.iam#ArnListType", "traits": { "smithy.api#documentation": "The name of the resource that is using the service-linked role.
" } } }, "traits": { "smithy.api#documentation": "An object that contains details about how a service-linked role is used, if that\n information is returned by the service.
\nThis data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
" } }, "com.amazonaws.iam#SAMLMetadataDocumentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1000, "max": 10000000 } } }, "com.amazonaws.iam#SAMLProviderListEntry": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SAML provider.
" } }, "ValidUntil": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The expiration date and time for the SAML provider.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the SAML provider was created.
" } } }, "traits": { "smithy.api#documentation": "Contains the list of SAML providers for this account.
" } }, "com.amazonaws.iam#SAMLProviderListType": { "type": "list", "member": { "target": "com.amazonaws.iam#SAMLProviderListEntry" } }, "com.amazonaws.iam#SAMLProviderNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w._-]+$" } }, "com.amazonaws.iam#SSHPublicKey": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the SSH public key.
", "smithy.api#required": {} } }, "SSHPublicKeyId": { "target": "com.amazonaws.iam#publicKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SSH public key.
", "smithy.api#required": {} } }, "Fingerprint": { "target": "com.amazonaws.iam#publicKeyFingerprintType", "traits": { "smithy.api#documentation": "The MD5 message digest of the SSH public key.
", "smithy.api#required": {} } }, "SSHPublicKeyBody": { "target": "com.amazonaws.iam#publicKeyMaterialType", "traits": { "smithy.api#documentation": "The SSH public key.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the SSH public key. Active
means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive
means that the key\n cannot be used.
The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an SSH public key.
\nThis data type is used as a response element in the GetSSHPublicKey\n and UploadSSHPublicKey operations.
" } }, "com.amazonaws.iam#SSHPublicKeyListType": { "type": "list", "member": { "target": "com.amazonaws.iam#SSHPublicKeyMetadata" } }, "com.amazonaws.iam#SSHPublicKeyMetadata": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the SSH public key.
", "smithy.api#required": {} } }, "SSHPublicKeyId": { "target": "com.amazonaws.iam#publicKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SSH public key.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the SSH public key. Active
means that the key can be used for\n authentication with an AWS CodeCommit repository. Inactive
means that the key\n cannot be used.
The date and time, in ISO 8601 date-time\n format, when the SSH public key was uploaded.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about an SSH public key, without the key's body or\n fingerprint.
\nThis data type is used as a response element in the ListSSHPublicKeys\n operation.
" } }, "com.amazonaws.iam#ServerCertificate": { "type": "structure", "members": { "ServerCertificateMetadata": { "target": "com.amazonaws.iam#ServerCertificateMetadata", "traits": { "smithy.api#documentation": "The meta information of the server certificate, such as its name, path, ID, and\n ARN.
", "smithy.api#required": {} } }, "CertificateBody": { "target": "com.amazonaws.iam#certificateBodyType", "traits": { "smithy.api#documentation": "The contents of the public key certificate.
", "smithy.api#required": {} } }, "CertificateChain": { "target": "com.amazonaws.iam#certificateChainType", "traits": { "smithy.api#documentation": "The contents of the public key certificate chain.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a server certificate.
\nThis data type is used as a response element in the GetServerCertificate operation.
" } }, "com.amazonaws.iam#ServerCertificateMetadata": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the server certificate. For more information about paths, see IAM\n identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "ServerCertificateName": { "target": "com.amazonaws.iam#serverCertificateNameType", "traits": { "smithy.api#documentation": "The name that identifies the server certificate.
", "smithy.api#required": {} } }, "ServerCertificateId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the server certificate. For more information\n about IDs, see IAM identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) specifying the server certificate. For more information\n about ARNs and how to use them in policies, see IAM identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "UploadDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date when the server certificate was uploaded.
" } }, "Expiration": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date on which the certificate is set to expire.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a server certificate without its certificate body,\n certificate chain, and private key.
\nThis data type is used as a response element in the UploadServerCertificate and ListServerCertificates\n operations.
" } }, "com.amazonaws.iam#ServiceFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#serviceFailureExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or\n failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iam#ServiceLastAccessed": { "type": "structure", "members": { "ServiceName": { "target": "com.amazonaws.iam#serviceNameType", "traits": { "smithy.api#documentation": "The name of the service in which access was attempted.
", "smithy.api#required": {} } }, "LastAuthenticated": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n service. AWS does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } }, "ServiceNamespace": { "target": "com.amazonaws.iam#serviceNamespaceType", "traits": { "smithy.api#documentation": "The namespace of the service in which access was attempted.
\nTo learn the service namespace of a service, see Actions, resources, and condition keys for AWS services in the\n Service Authorization Reference. Choose the name of the service to\n view details for that service. In the first paragraph, find the service prefix. For\n example, (service prefix: a4b)
. For more information about service namespaces,\n see AWS\n Service Namespaces in the AWS General Reference.
The ARN of the authenticated entity (user or role) that last attempted to access the\n service. AWS does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } }, "LastAuthenticatedRegion": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The Region from which the authenticated entity (user or role) last attempted to access\n the service. AWS does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } }, "TotalAuthenticatedEntities": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The total number of authenticated principals (root user, IAM users, or IAM roles)\n that have attempted to access the service.
\nThis field is null if no principals attempted to access the service within the reporting period.
" } }, "TrackedActionsLastAccessed": { "target": "com.amazonaws.iam#TrackedActionsLastAccessed", "traits": { "smithy.api#documentation": "An object that contains details about the most recent attempt to access a tracked action\n within the service.
\nThis field is null if there no tracked actions or if the principal did not use the\n tracked actions within the reporting period. This field is also null if the report was generated at the\n service level and not the action level. For more information, see the\n Granularity
field in GenerateServiceLastAccessedDetails.
Contains details about the most recent attempt to access the service.
\nThis data type is used as a response element in the GetServiceLastAccessedDetails operation.
" } }, "com.amazonaws.iam#ServiceNotSupportedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#serviceNotSupportedMessage" } }, "traits": { "smithy.api#documentation": "The specified service does not support service-specific credentials.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iam#ServiceSpecificCredential": { "type": "structure", "members": { "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.
", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.iam#serviceName", "traits": { "smithy.api#documentation": "The name of the service associated with the service-specific credential.
", "smithy.api#required": {} } }, "ServiceUserName": { "target": "com.amazonaws.iam#serviceUserName", "traits": { "smithy.api#documentation": "The generated user name for the service-specific credential. This value is generated by\n combining the IAM user's name combined with the ID number of the AWS account, as in\n jane-at-123456789012
, for example. This value cannot be configured by the\n user.
The generated password for the service-specific credential.
", "smithy.api#required": {} } }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "The unique identifier for the service-specific credential.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the service-specific credential.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the service-specific credential. Active
means that the key is\n valid for API calls, while Inactive
means it is not.
Contains the details of a service-specific credential.
" } }, "com.amazonaws.iam#ServiceSpecificCredentialMetadata": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the service-specific credential.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the service-specific credential. Active
means that the key is\n valid for API calls, while Inactive
means it is not.
The generated user name for the service-specific credential.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the service-specific credential were created.
", "smithy.api#required": {} } }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "The unique identifier for the service-specific credential.
", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.iam#serviceName", "traits": { "smithy.api#documentation": "The name of the service associated with the service-specific credential.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains additional details about a service-specific credential.
" } }, "com.amazonaws.iam#ServiceSpecificCredentialsListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ServiceSpecificCredentialMetadata" } }, "com.amazonaws.iam#ServicesLastAccessed": { "type": "list", "member": { "target": "com.amazonaws.iam#ServiceLastAccessed" } }, "com.amazonaws.iam#SetDefaultPolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#SetDefaultPolicyVersionRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Sets the specified version of the specified policy as the policy's default (operative)\n version.
\nThis operation affects all users, groups, and roles that the policy is attached to. To\n list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
\nFor information about managed policies, see Managed policies and inline\n policies in the IAM User Guide.
" } }, "com.amazonaws.iam#SetDefaultPolicyVersionRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM policy whose default version you want to\n set.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.iam#policyVersionIdType", "traits": { "smithy.api#documentation": "The version of the policy to set as the default (operative) version.
\nFor more information about managed policy versions, see Versioning for managed\n policies in the IAM User Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#SetSecurityTokenServicePreferences": { "type": "operation", "input": { "target": "com.amazonaws.iam#SetSecurityTokenServicePreferencesRequest" }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Sets the specified version of the global endpoint token as the token version used for\n the AWS account.
\nBy default, AWS Security Token Service (STS) is available as a global service, and all STS requests\n go to a single endpoint at https://sts.amazonaws.com
. AWS recommends\n using Regional STS endpoints to reduce latency, build in redundancy, and increase\n session token availability. For information about Regional endpoints for STS, see\n AWS AWS Security Token\n Service endpoints and quotas in the\n AWS General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might\n be valid in some Regions but not others. It depends on the version that is set in this\n operation. Version 1 tokens are valid only in AWS Regions that are available by\n default. These tokens do not work in manually enabled Regions, such as Asia Pacific\n (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are\n longer and might affect systems where you temporarily store tokens. For information, see\n Activating and\n deactivating STS in an AWS region in the\n IAM User Guide.
\nTo view the current session token version, see the\n GlobalEndpointTokenVersion
entry in the response of the GetAccountSummary operation.
The version of the global endpoint token. Version 1 tokens are valid only in AWS\n Regions that are available by default. These tokens do not work in manually enabled\n Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions.\n However, version 2 tokens are longer and might affect systems where you temporarily\n store tokens.
\nFor information, see Activating and\n deactivating STS in an AWS region in the\n IAM User Guide.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#SigningCertificate": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the user the signing certificate is associated with.
", "smithy.api#required": {} } }, "CertificateId": { "target": "com.amazonaws.iam#certificateIdType", "traits": { "smithy.api#documentation": "The ID for the signing certificate.
", "smithy.api#required": {} } }, "CertificateBody": { "target": "com.amazonaws.iam#certificateBodyType", "traits": { "smithy.api#documentation": "The contents of the signing certificate.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status of the signing certificate. Active
means that the key is valid\n for API calls, while Inactive
means it is not.
The date when the signing certificate was uploaded.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an X.509 signing certificate.
\nThis data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates\n operations.
" } }, "com.amazonaws.iam#SimulateCustomPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#SimulateCustomPolicyRequest" }, "output": { "target": "com.amazonaws.iam#SimulatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#PolicyEvaluationException" } ], "traits": { "smithy.api#documentation": "Simulate how a set of IAM policies and optionally a resource-based policy works with\n a list of API operations and AWS resources to determine the policies' effective\n permissions. The policies are provided as strings.
\nThe simulation does not perform the API operations; it only checks the authorization\n to determine if the simulated policies allow or deny the operations. You can simulate\n resources that don't exist in your account.
\nIf you want to simulate existing policies that are attached to an IAM user, group,\n or role, use SimulatePrincipalPolicy instead.
\nContext keys are variables that are maintained by AWS and its services and which\n provide details about the context of an API query request. You can use the\n Condition
element of an IAM policy to evaluate context keys. To get\n 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
\n parameters to paginate the results.
For more information about using the policy simulator, see Testing IAM policies\n with the IAM policy simulator in the\n IAM User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "EvaluationResults", "pageSize": "MaxItems" } } }, "com.amazonaws.iam#SimulateCustomPolicyRequest": { "type": "structure", "members": { "PolicyInputList": { "target": "com.amazonaws.iam#SimulationPolicyListType", "traits": { "smithy.api#documentation": "A list of policy documents to include in the simulation. Each document is specified as\n a string containing the complete, valid JSON text of an IAM policy. Do not include any\n resource-based policies in this parameter. Any resource-based policy must be submitted\n with the ResourcePolicy
parameter. The policies cannot be \"scope-down\"\n policies, such as you could include in a call to GetFederationToken or one of\n the AssumeRole API operations. In other words, do not use policies designed to\n restrict what a user can do while using the temporary credentials.
The regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that an IAM entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. For more information about\n permissions boundaries, see Permissions boundaries for IAM\n entities in the IAM User Guide. The policy input is\n specified as a string that contains the complete, valid JSON text of a permissions\n boundary policy.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated against each resource. Each operation must include the service identifier,\n such as iam:CreateUser
. This operation does not support using wildcards (*)\n in an action name.
A list of ARNs of AWS resources to include in the simulation. If this parameter is\n not provided, then the value defaults to *
(all resources). Each API in the\n ActionNames
parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and\n reports it in the response. You can simulate resources that don't exist in your\n account.
The simulation does not automatically retrieve policies for the specified resources.\n If you want to include a resource policy in the simulation, then you must include the\n policy as a string in the ResourcePolicy
parameter.
If you include a ResourcePolicy
, then it must be applicable to all of the\n resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
" } }, "ResourcePolicy": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "A resource-based policy to include in the simulation provided as a string. Each\n resource in the simulation is treated as if it had this policy attached. You can include\n only one resource-based policy in a simulation.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
An ARN representing the AWS account ID that specifies the owner of any simulated\n resource that does not identify its owner in the resource ARN. Examples of resource ARNs\n include an S3 bucket or object. If ResourceOwner
is specified, it is also\n used as the account owner of any ResourcePolicy
included in the simulation.\n If the ResourceOwner
parameter is not specified, then the owner of the\n resources and the resource policy defaults to the account of the identity provided in\n CallerArn
. This parameter is required only if you specify a\n resource-based policy and account that owns the resource is different from the account\n that owns the simulated calling user CallerArn
.
The ARN for an account uses the following syntax:\n arn:aws:iam::AWS-account-ID:root
. For example,\n to represent the account with the 112233445566 ID, use the following ARN:\n arn:aws:iam::112233445566-ID:root
.
The ARN of the IAM user that you want to use as the simulated caller of the API\n operations. CallerArn
is required if you include a\n ResourcePolicy
so that the policy's Principal
element has\n 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\n assumed role, federated user, or a service principal.
" } }, "ContextEntries": { "target": "com.amazonaws.iam#ContextEntryListType", "traits": { "smithy.api#documentation": "A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.
" } }, "ResourceHandlingOption": { "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { "smithy.api#documentation": "Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the EC2 scenarios requires that you specify instance, image, and\n security-group resources. If your scenario includes an EBS volume, then you must specify\n that volume as a resource. If the EC2 scenario includes VPC, then you must supply the\n network-interface resource. If it includes an IP subnet, then you must specify the\n subnet resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.
\n\n EC2-Classic-InstanceStore\n
\ninstance, image, security-group
\n\n EC2-Classic-EBS\n
\ninstance, image, security-group, volume
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security-group, network-interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security-group, network-interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security-group, network-interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security-group, network-interface, subnet, volume
\nUse this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The results of the simulation.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#documentation": "A flag that indicates whether there are more items to return. If your \n results were truncated, you can make a subsequent pagination request using the Marker
\n request parameter to retrieve more items. Note that IAM might return fewer than the \n MaxItems
number of results even when there are more results available. We recommend \n that you check IsTruncated
after every call to ensure that you receive all your \n results.
When IsTruncated
is true
, this element\n is present and contains the value to use for the Marker
parameter in a subsequent \n pagination request.
Contains the response to a successful SimulatePrincipalPolicy or\n SimulateCustomPolicy request.
" } }, "com.amazonaws.iam#SimulatePrincipalPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#SimulatePrincipalPolicyRequest" }, "output": { "target": "com.amazonaws.iam#SimulatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PolicyEvaluationException" } ], "traits": { "smithy.api#documentation": "Simulate how a set of IAM policies attached to an IAM entity works with a list of\n API operations and AWS resources to determine the policies' effective permissions. The\n entity can be an IAM user, group, or role. If you specify a user, then the simulation\n also includes all of the policies that are attached to groups that the user belongs to.\n You can simulate resources that don't exist in your account.
\nYou can optionally include a list of one or more additional policies specified as\n strings to include in the simulation. If you want to simulate only policies specified as\n strings, use SimulateCustomPolicy instead.
\nYou can also optionally include one resource-based policy to be evaluated with each of\n the resources included in the simulation.
\nThe simulation does not perform the API operations; it only checks the authorization\n to determine if the simulated policies allow or deny the operations.
\n\n Note: This operation discloses information about the\n permissions granted to other users. If you do not want users to see other user's\n permissions, then consider allowing them to use SimulateCustomPolicy\n instead.
\nContext keys are variables maintained by AWS and its services that provide details\n about the context of an API query request. You can use the Condition
\n element of an IAM policy to evaluate context keys. To get the list of context keys\n that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems
and Marker
\n parameters to paginate the results.
For more information about using the policy simulator, see Testing IAM policies\n with the IAM policy simulator in the\n IAM User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "EvaluationResults", "pageSize": "MaxItems" } } }, "com.amazonaws.iam#SimulatePrincipalPolicyRequest": { "type": "structure", "members": { "PolicySourceArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to\n include in the simulation. If you specify a user, group, or role, the simulation\n includes all policies that are associated with that entity. If you specify a user, the\n simulation also includes all policies that are attached to any groups the user belongs\n to.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "PolicyInputList": { "target": "com.amazonaws.iam#SimulationPolicyListType", "traits": { "smithy.api#documentation": "An optional list of additional policy documents to include in the simulation. Each\n document is specified as a string containing the complete, valid JSON text of an IAM\n policy.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
The IAM permissions boundary policy to simulate. The permissions boundary sets the\n maximum permissions that the entity can have. You can input only one permissions\n boundary when you pass a policy to this operation. An IAM entity can only have one\n permissions boundary in effect at a time. For example, if a permissions boundary is\n attached to an entity and you pass in a different permissions boundary policy using this\n parameter, then the new permissions boundary policy is used for the simulation. For more\n information about permissions boundaries, see Permissions boundaries for IAM\n entities in the IAM User Guide. The policy input is\n specified as a string containing the complete, valid JSON text of a permissions boundary\n policy.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
A list of names of API operations to evaluate in the simulation. Each operation is\n evaluated for each resource. Each operation must include the service identifier, such as\n iam:CreateUser
.
A list of ARNs of AWS resources to include in the simulation. If this parameter is\n not provided, then the value defaults to *
(all resources). Each API in the\n ActionNames
parameter is evaluated for each resource in this list. The\n simulation determines the access result (allowed or denied) of each combination and\n reports it in the response. You can simulate resources that don't exist in your\n account.
The simulation does not automatically retrieve policies for the specified resources.\n If you want to include a resource policy in the simulation, then you must include the\n policy as a string in the ResourcePolicy
parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
" } }, "ResourcePolicy": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "A resource-based policy to include in the simulation provided as a string. Each\n resource in the simulation is treated as if it had this policy attached. You can include\n only one resource-based policy in a simulation.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
An AWS account ID that specifies the owner of any simulated resource that does not\n identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket\n or object. If ResourceOwner
is specified, it is also used as the account\n owner of any ResourcePolicy
included in the simulation. If the\n ResourceOwner
parameter is not specified, then the owner of the\n resources and the resource policy defaults to the account of the identity provided in\n CallerArn
. This parameter is required only if you specify a\n resource-based policy and account that owns the resource is different from the account\n that owns the simulated calling user CallerArn
.
The ARN of the IAM user that you want to specify as the simulated caller of the API\n operations. If you do not specify a CallerArn
, it defaults to the ARN of\n the user that you specify in PolicySourceArn
, if you specified a user. If\n you include both a PolicySourceArn
(for example,\n arn:aws:iam::123456789012:user/David
) and a CallerArn
(for\n example, arn:aws:iam::123456789012:user/Bob
), the result is that you\n 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\n assumed role, federated user, or a service principal.
\n\n CallerArn
is required if you include a ResourcePolicy
and\n the PolicySourceArn
is not the ARN for an IAM user. This is required so\n that the resource-based policy's Principal
element has a value to use in\n evaluating the policy.
For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
" } }, "ContextEntries": { "target": "com.amazonaws.iam#ContextEntryListType", "traits": { "smithy.api#documentation": "A list of context keys and corresponding values for the simulation to use. Whenever a\n context key is evaluated in one of the simulated IAM permissions policies, the\n corresponding value is supplied.
" } }, "ResourceHandlingOption": { "target": "com.amazonaws.iam#ResourceHandlingOptionType", "traits": { "smithy.api#documentation": "Specifies the type of simulation to run. Different API operations that support\n resource-based policies require different combinations of resources. By specifying the\n type of simulation to run, you enable the policy simulator to enforce the presence of\n the required resources to ensure reliable simulation results. If your simulation does\n not match one of the following scenarios, then you can omit this parameter. The\n following list shows each of the supported scenario values and the resources that you\n must define to run the simulation.
\nEach of the EC2 scenarios requires that you specify instance, image, and security\n group resources. If your scenario includes an EBS volume, then you must specify that\n volume as a resource. If the EC2 scenario includes VPC, then you must supply the network\n interface resource. If it includes an IP subnet, then you must specify the subnet\n resource. For more information on the EC2 scenario options, see Supported platforms in the Amazon EC2 User\n Guide.
\n\n EC2-Classic-InstanceStore\n
\ninstance, image, security group
\n\n EC2-Classic-EBS\n
\ninstance, image, security group, volume
\n\n EC2-VPC-InstanceStore\n
\ninstance, image, security group, network interface
\n\n EC2-VPC-InstanceStore-Subnet\n
\ninstance, image, security group, network interface, subnet
\n\n EC2-VPC-EBS\n
\ninstance, image, security group, network interface, volume
\n\n EC2-VPC-EBS-Subnet\n
\ninstance, image, security group, network interface, subnet, volume
\nUse this only when paginating results to indicate the \n maximum number of items you want in the response. If additional items exist beyond the maximum \n you specify, the IsTruncated
response element is true
.
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM might return fewer results, even when there are more results available. In that case, the\n IsTruncated
response element returns true
, and Marker
\n contains a value to include in the subsequent call that tells the service where to continue \n from.
Use this parameter only when paginating results and only after \n you receive a response indicating that the results are truncated. Set it to the value of the\n Marker
element in the response that you received to indicate where the next call \n should start.
The identifier of the policy that was provided as an input.
" } }, "SourcePolicyType": { "target": "com.amazonaws.iam#PolicySourceType", "traits": { "smithy.api#documentation": "The type of the policy.
" } }, "StartPosition": { "target": "com.amazonaws.iam#Position", "traits": { "smithy.api#documentation": "The row and column of the beginning of the Statement
in an IAM\n policy.
The row and column of the end of a Statement
in an IAM policy.
Contains a reference to a Statement
element in a policy document that\n determines the result of the simulation.
This data type is used by the MatchedStatements
member of the \n EvaluationResult\n
type.
The key name that can be used to look up or retrieve the associated value. For example,\n Department
or Cost Center
are common choices.
The value associated with this tag. For example, tags with a key name of\n Department
could have values such as Human Resources
,\n Accounting
, and Support
. Tags with a key name of Cost\n Center
might have values that consist of the number associated with the different\n cost centers in your company. Typically, many resources have tags with the same key name but\n with different values.
AWS always interprets the tag Value
as a single string. If you need to\n store an array, you can store comma-separated values in the string. However, you must\n interpret the value in your code.
A structure that represents user-provided metadata that can be associated with an IAM\n resource. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#TagInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagInstanceProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM instance profile. If a tag with the same key name\n already exists, then that tag is overwritten with the new value.
\nEach tag consists of a key name and an associated value. By assigning tags to your resources, you can do the\n following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM instance\n profile that has a specified tag attached. For examples of policies that show how to use\n tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The name of the IAM instance profile to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM instance profile.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If\n a tag with the same key name already exists, then that tag is overwritten with the new\n value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM virtual\n MFA device that has a specified tag attached. For examples of policies that show how to\n use tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The unique identifier for the IAM virtual MFA device to which you want to add tags.\n For virtual MFA devices, the serial number is the same as the ARN.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM virtual MFA device.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagOpenIDConnectProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For\n more information about these providers, see About web identity federation. If\n a tag with the same key name already exists, then that tag is overwritten with the new\n value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an OIDC provider\n that has a specified tag attached. For examples of policies that show how to use tags to\n control access, see Control access using IAM tags in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The ARN of the OIDC identity provider in IAM to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the OIDC identity provider in IAM.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM customer managed policy. If a tag with the same key\n name already exists, then that tag is overwritten with the new value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM customer\n managed policy that has a specified tag attached. For examples of policies that show how\n to use tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The ARN of the IAM customer managed policy to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM customer managed policy.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagRoleRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM role. The role can be a regular role or a\n service-linked role. If a tag with the same key name already exists, then that tag is\n overwritten with the new value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM role\n that has a specified tag attached. You can also restrict access to only those resources\n that have a certain tag attached. For examples of policies that show how to use tags to\n control access, see Control access using IAM tags in the\n IAM User Guide.
\n\n Cost allocation - Use tags to help track which\n individuals and teams are using which AWS resources.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the\n IAM User Guide.
" } }, "com.amazonaws.iam#TagRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the IAM role to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM role. Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagSAMLProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider.\n For more information about these providers, see About SAML 2.0-based federation .\n If a tag with the same key name already exists, then that tag is overwritten with the new\n value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only a SAML identity\n provider that has a specified tag attached. For examples of policies that show how to use\n tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The ARN of the SAML identity provider in IAM to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the SAML identity provider in IAM.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagServerCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM server certificate. If a tag with the same key name\n already exists, then that tag is overwritten with the new value.
\nFor certificates in a Region supported by AWS Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only a server\n certificate that has a specified tag attached. For examples of policies that show how to\n use tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\n\n Cost allocation - Use tags to help track which\n individuals and teams are using which AWS resources.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
The name of the IAM server certificate to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM server certificate.\n Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TagUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagUserRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an IAM user. If a tag with the same key name already exists,\n then that tag is overwritten with the new value.
\nA tag consists of a key name and an associated value. By assigning tags to your\n resources, you can do the following:
\n\n Administrative grouping and discovery - Attach\n tags to resources to aid in organization and search. For example, you could search for all\n resources with the key name Project and the value\n MyImportantProject. Or search for all resources with the key name\n Cost Center and the value 41200.
\n\n Access control - Include tags in IAM user-based\n and resource-based policies. You can use tags to restrict access to only an IAM\n requesting user that has a specified tag attached. You can also restrict access to only\n those resources that have a certain tag attached. For examples of policies that show how\n to use tags to control access, see Control access using IAM tags in the\n IAM User Guide.
\n\n Cost allocation - Use tags to help track which\n individuals and teams are using which AWS resources.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nAWS always interprets the tag Value
as a single string. If you\n need to store an array, you can store comma-separated values in the string. However, you\n must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the\n IAM User Guide.
" } }, "com.amazonaws.iam#TagUserRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the IAM user to which you want to add tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "The list of tags that you want to attach to the IAM user. Each tag consists of a key name and an associated value.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#TrackedActionLastAccessed": { "type": "structure", "members": { "ActionName": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The name of the tracked action to which access was attempted. Tracked actions are\n actions that report activity to IAM.
" } }, "LastAccessedEntity": { "target": "com.amazonaws.iam#arnType" }, "LastAccessedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n tracked service. AWS does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } }, "LastAccessedRegion": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The Region from which the authenticated entity (user or role) last attempted to access\n the tracked action. AWS does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n reporting period.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the most recent attempt to access an action within the service.
\nThis data type is used as a response element in the GetServiceLastAccessedDetails operation.
" } }, "com.amazonaws.iam#TrackedActionsLastAccessed": { "type": "list", "member": { "target": "com.amazonaws.iam#TrackedActionLastAccessed" } }, "com.amazonaws.iam#UnmodifiableEntityException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#unmodifiableEntityMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because only the service that depends on the service-linked role\n can modify or delete the role on your behalf. The error message includes the name of the\n service that depends on this service-linked role. You must request the change through that\n service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#unrecognizedPublicKeyEncodingMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the public key encoding format is unsupported or\n unrecognized.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#UntagInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagInstanceProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagInstanceProfileRequest": { "type": "structure", "members": { "InstanceProfileName": { "target": "com.amazonaws.iam#instanceProfileNameType", "traits": { "smithy.api#documentation": "The name of the IAM instance profile from which you want to remove tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified instance profile.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagMFADeviceRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the IAM virtual multi-factor authentication (MFA)\n device. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagMFADeviceRequest": { "type": "structure", "members": { "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The unique identifier for the IAM virtual MFA device from which you want to remove\n tags. For virtual MFA devices, the serial number is the same as the ARN.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified instance profile.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagOpenIDConnectProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity\n provider in IAM. For more information about OIDC providers, see About web identity federation.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagOpenIDConnectProviderRequest": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the OIDC provider in IAM from which you want to remove tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified OIDC provider.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagPolicyRequest": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the IAM customer managed policy from which you want to remove\n tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified policy.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagRoleRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the IAM role from which you want to remove tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified role.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagSAMLProviderRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the specified Security Assertion Markup Language (SAML)\n identity provider in IAM. For more information about these providers, see About web identity\n federation. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagSAMLProviderRequest": { "type": "structure", "members": { "SAMLProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the SAML identity provider in IAM from which you want to remove\n tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified SAML identity provider.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagServerCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the IAM server certificate.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nFor certificates in a Region supported by AWS Certificate Manager (ACM), we\n recommend that you don't use IAM server certificates. Instead, use ACM to provision,\n manage, and deploy your server certificates. For more information about IAM server\n certificates, Working with server\n certificates in the IAM User Guide.
\nThe name of the IAM server certificate from which you want to remove tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified IAM server certificate.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UntagUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagUserRequest" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UntagUserRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the IAM user from which you want to remove tags.
\nThis parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: =,.@-
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.iam#tagKeyListType", "traits": { "smithy.api#documentation": "A list of key names as a simple array of strings. The tags with matching keys are\n removed from the specified user.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UpdateAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateAccessKeyRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Changes the status of the specified access key from Active to Inactive, or vice versa.\n This operation can be used to disable a user's key as part of a key rotation\n workflow.
\nIf the UserName
is not specified, the user name is determined implicitly\n based on the AWS access key ID used to sign the request. This operation works for\n access keys under the AWS account. Consequently, you can use this operation to manage\n AWS account root user credentials even if the AWS account has no associated\n users.
For information about rotating keys, see Managing keys and certificates\n in the IAM User Guide.
" } }, "com.amazonaws.iam#UpdateAccessKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the user whose key you want to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "AccessKeyId": { "target": "com.amazonaws.iam#accessKeyIdType", "traits": { "smithy.api#documentation": "The access key ID of the secret access key you want to update.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": " The status you want to assign to the secret access key. Active
means\n that the key can be used for programmatic calls to AWS, while Inactive
\n means that the key cannot be used.
Updates the password policy settings for the AWS account.
\nThis operation does not support partial updates. No parameters are\n required, but if you do not specify a parameter, that parameter's value\n reverts to its default value. See the Request\n Parameters section for each parameter's default value. Also\n note that some parameters do not allow the default parameter to be\n explicitly set. Instead, to invoke the default value, do not include that\n parameter when you invoke the operation.
\nFor more information about using a password policy, see Managing an IAM password\n policy in the IAM User Guide.
" } }, "com.amazonaws.iam#UpdateAccountPasswordPolicyRequest": { "type": "structure", "members": { "MinimumPasswordLength": { "target": "com.amazonaws.iam#minimumPasswordLengthType", "traits": { "smithy.api#documentation": "The minimum number of characters allowed in an IAM user password.
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of 6
.
Specifies whether IAM user passwords must contain at least one of the following\n non-alphanumeric characters:
\n! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that passwords do not require at least one\n symbol character.
Specifies whether IAM user passwords must contain at least one numeric character (0\n to 9).
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that passwords do not require at least one\n numeric character.
Specifies whether IAM user passwords must contain at least one uppercase character\n from the ISO basic Latin alphabet (A to Z).
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that passwords do not require at least one\n uppercase character.
Specifies whether IAM user passwords must contain at least one lowercase character\n from the ISO basic Latin alphabet (a to z).
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that passwords do not require at least one\n lowercase character.
Allows all IAM users in your account to use the AWS Management Console to change their own\n passwords. For more information, see Letting IAM users change their own\n passwords in the IAM User Guide.
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that IAM users in the account do not\n automatically have permissions to change their own password.
The number of days that an IAM user password is valid.
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of 0
. The result is that IAM user passwords never expire.
Specifies the number of previous passwords that IAM users are prevented from\n reusing.
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of 0
. The result is that IAM users are not prevented from reusing\n previous passwords.
Prevents IAM users from setting a new password after their password has expired. The\n IAM user cannot be accessed until an administrator resets the password.
\nIf you do not specify a value for this parameter, then the operation uses the default\n value of false
. The result is that IAM users can change their passwords\n after they expire and continue to sign in as the user.
Updates the policy that grants an IAM entity permission to assume a role. This is\n typically referred to as the \"role trust policy\". For more information about roles, see\n Using roles to\n delegate permissions and federate identities.
" } }, "com.amazonaws.iam#UpdateAssumeRolePolicyRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role to update with the new policy.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The policy that grants an entity permission to assume the role.
\nYou must provide policies in JSON format in IAM. However, for AWS CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS\n CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Updates the name and/or the path of the specified IAM group.
\nYou should understand the implications of changing a group's path or name. For\n more information, see Renaming users and\n groups in the IAM User Guide.
\nThe person making the request (the principal), must have permission to change the\n role group with the old name and the new name. For example, to change the group\n named Managers
to MGRs
, the principal must have a policy\n that allows them to update both groups. If the principal has permission to update\n the Managers
group, but not the MGRs
group, then the\n update fails. For more information about permissions, see Access management.\n
Name of the IAM group to update. If you're changing the name of the group, this is\n the original name.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "NewPath": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "New path for the IAM group. Only include this if changing the group's path.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
New name for the IAM group. Only include this if changing the group's name.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
" } } } }, "com.amazonaws.iam#UpdateLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateLoginProfileRequest" }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#PasswordPolicyViolationException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Changes the password for the specified IAM user. You can use the AWS CLI, the\n AWS API, or the Users page in the IAM console to\n change the password for any IAM user. Use ChangePassword to change\n your own password in the My Security Credentials page\n in the AWS Management Console.
\nFor more information about modifying passwords, see Managing passwords in the\n IAM User Guide.
" } }, "com.amazonaws.iam#UpdateLoginProfileRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the user whose password you want to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.iam#passwordType", "traits": { "smithy.api#documentation": "The new password for the specified IAM user.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
However, the format can be further restricted by the account administrator by setting\n a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.
" } }, "PasswordResetRequired": { "target": "com.amazonaws.iam#booleanObjectType", "traits": { "smithy.api#documentation": "Allows this new password to be used only once by requiring the specified IAM user to\n set a new password on next sign-in.
" } } } }, "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprint": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Replaces the existing list of server certificate thumbprints associated with an OpenID\n Connect (OIDC) provider resource object with a new list of thumbprints.
\nThe list that you pass with this operation completely replaces the existing list of\n thumbprints. (The lists are not merged.)
\nTypically, you need to update a thumbprint only when the identity provider's\n certificate changes, which occurs rarely. However, if the provider's certificate\n does change, any attempt to assume an IAM role that specifies\n the OIDC provider as a principal fails until the certificate thumbprint is\n updated.
\nTrust for the OIDC provider is derived from the provider's certificate and is\n validated by the thumbprint. Therefore, it is best to limit access to the\n UpdateOpenIDConnectProviderThumbprint
operation to highly\n privileged users.
The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which\n you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the\n ListOpenIDConnectProviders operation.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } }, "ThumbprintList": { "target": "com.amazonaws.iam#thumbprintListType", "traits": { "smithy.api#documentation": "A list of certificate thumbprints that are associated with the specified IAM OpenID\n Connect provider. For more information, see CreateOpenIDConnectProvider.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UpdateRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateRoleRequest" }, "output": { "target": "com.amazonaws.iam#UpdateRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Updates the description or maximum session duration setting of a role.
" } }, "com.amazonaws.iam#UpdateRoleDescription": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateRoleDescriptionRequest" }, "output": { "target": "com.amazonaws.iam#UpdateRoleDescriptionResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Use UpdateRole instead.
\nModifies only the description of a role. This operation performs the same function as\n the Description
parameter in the UpdateRole
operation.
The name of the role that you want to modify.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.iam#roleDescriptionType", "traits": { "smithy.api#documentation": "The new description that you want to apply to the specified role.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UpdateRoleDescriptionResponse": { "type": "structure", "members": { "Role": { "target": "com.amazonaws.iam#Role", "traits": { "smithy.api#documentation": "A structure that contains details about the modified role.
" } } } }, "com.amazonaws.iam#UpdateRoleRequest": { "type": "structure", "members": { "RoleName": { "target": "com.amazonaws.iam#roleNameType", "traits": { "smithy.api#documentation": "The name of the role that you want to modify.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.iam#roleDescriptionType", "traits": { "smithy.api#documentation": "The new description that you want to apply to the specified role.
" } }, "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { "smithy.api#documentation": "The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default maximum of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.
\nAnyone who assumes the role from the AWS CLI or API can use the\n DurationSeconds
API parameter or the duration-seconds
CLI\n parameter to request a longer session. The MaxSessionDuration
setting\n determines the maximum duration that can be requested using the\n DurationSeconds
parameter. If users don't specify a value for the\n DurationSeconds
parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole*
API operations\n or the assume-role*
CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.
Updates the metadata document for an existing SAML provider resource object.
\nThis operation requires Signature Version 4.
\nAn XML document generated by an identity provider (IdP) that supports SAML 2.0. The\n document includes the issuer's name, expiration information, and keys that can be used\n to validate the SAML authentication response (assertions) that are received from the\n IdP. You must generate the metadata document using the identity management software that\n is used as your organization's IdP.
", "smithy.api#required": {} } }, "SAMLProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SAML provider to update.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UpdateSAMLProviderResponse": { "type": "structure", "members": { "SAMLProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SAML provider that was updated.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful UpdateSAMLProvider request.\n
" } }, "com.amazonaws.iam#UpdateSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateSSHPublicKeyRequest" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Sets the status of an IAM user's SSH public key to active or inactive. SSH public\n keys that are inactive cannot be used for authentication. This operation can be used to\n disable a user's SSH public key as part of a key rotation work flow.
\nThe SSH public key affected by this operation is used only for authenticating the\n associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys\n to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for\n SSH connections in the AWS CodeCommit User Guide.
" } }, "com.amazonaws.iam#UpdateSSHPublicKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user associated with the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SSHPublicKeyId": { "target": "com.amazonaws.iam#publicKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SSH public key.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status to assign to the SSH public key. Active
means that the key can\n be used for authentication with an AWS CodeCommit repository. Inactive
means that\n the key cannot be used.
Updates the name and/or the path of the specified server certificate stored in\n IAM.
\nFor more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic also includes a list of AWS services that can use the server certificates that\n you manage with IAM.
\nYou should understand the implications of changing a server certificate's path or\n name. For more information, see Renaming a server certificate in the\n IAM User Guide.
\nThe person making the request (the principal), must have permission to change the\n server certificate with the old name and the new name. For example, to change the\n certificate named ProductionCert
to ProdCert
, the\n principal must have a policy that allows them to update both certificates. If the\n principal has permission to update the ProductionCert
group, but not\n the ProdCert
certificate, then the update fails. For more information\n about permissions, see Access management in the IAM User Guide.
The name of the server certificate that you want to update.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "NewPath": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The new path for the server certificate. Include this only if you are updating the\n server certificate's path.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
The new name for the server certificate. Include this only if you are updating the\n server certificate's name. The name of the certificate cannot contain any spaces.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } } } }, "com.amazonaws.iam#UpdateServiceSpecificCredential": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" } ], "traits": { "smithy.api#documentation": "Sets the status of a service-specific credential to Active
or\n Inactive
. Service-specific credentials that are inactive cannot be used\n for authentication to the service. This operation can be used to disable a user's\n service-specific credential as part of a credential rotation work flow.
The name of the IAM user associated with the service-specific credential. If you do\n not specify this value, then the operation assumes the user whose credentials are used\n to call the operation.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "ServiceSpecificCredentialId": { "target": "com.amazonaws.iam#serviceSpecificCredentialId", "traits": { "smithy.api#documentation": "The unique identifier of the service-specific credential.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": "The status to be assigned to the service-specific credential.
", "smithy.api#required": {} } } } }, "com.amazonaws.iam#UpdateSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateSigningCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Changes the status of the specified user signing certificate from active to disabled,\n or vice versa. This operation can be used to disable an IAM user's signing certificate\n as part of a certificate rotation work flow.
\nIf the UserName
field is not specified, the user name is determined\n implicitly based on the AWS access key ID used to sign the request. This operation\n works for access keys under the AWS account. Consequently, you can use this operation\n to manage AWS account root user credentials even if the AWS account has no\n associated users.
The name of the IAM user the signing certificate belongs to.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "CertificateId": { "target": "com.amazonaws.iam#certificateIdType", "traits": { "smithy.api#documentation": "The ID of the signing certificate you want to update.
\nThis parameter allows (through its regex pattern) a string of characters that can \n consist of any upper or lowercased letter or digit.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.iam#statusType", "traits": { "smithy.api#documentation": " The status you want to assign to the certificate. Active
means that the\n certificate can be used for programmatic calls to AWS Inactive
means that\n the certificate cannot be used.
Updates the name and/or the path of the specified IAM user.
\nYou should understand the implications of changing an IAM user's path or name.\n For more information, see Renaming an IAM\n user and Renaming an IAM\n group in the IAM User Guide.
\nTo change a user name, the requester must have appropriate permissions on both\n the source object and the target object. For example, to change Bob to Robert, the\n entity making the request must have permission on Bob and Robert, or must have\n permission on all (*). For more information about permissions, see Permissions and policies.
\nName of the user to update. If you're changing the name of the user, this is the\n original user name.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "NewPath": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "New path for the IAM user. Include this parameter only if you're changing the user's\n path.
\nThis parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n 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\n name.
\nIAM user, group, role, and policy names must be unique within the account. Names are\n not distinguished by case. For example, you cannot create resources named both\n \"MyResource\" and \"myresource\".
" } } } }, "com.amazonaws.iam#UploadSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#UploadSSHPublicKeyRequest" }, "output": { "target": "com.amazonaws.iam#UploadSSHPublicKeyResponse" }, "errors": [ { "target": "com.amazonaws.iam#DuplicateSSHPublicKeyException" }, { "target": "com.amazonaws.iam#InvalidPublicKeyException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException" } ], "traits": { "smithy.api#documentation": "Uploads an SSH public key and associates it with the specified IAM user.
\nThe SSH public key uploaded by this operation can be used only for authenticating the\n associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys\n to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for\n SSH connections in the AWS CodeCommit User Guide.
" } }, "com.amazonaws.iam#UploadSSHPublicKeyRequest": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The name of the IAM user to associate the SSH public key with.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "SSHPublicKeyBody": { "target": "com.amazonaws.iam#publicKeyMaterialType", "traits": { "smithy.api#documentation": "The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.\n The minimum bit-length of the public key is 2048 bits. For example, you can generate a\n 2048-bit key, and the resulting PEM file is 1679 bytes long.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Contains information about the SSH public key.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful UploadSSHPublicKey\n request.
" } }, "com.amazonaws.iam#UploadServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UploadServerCertificateRequest" }, "output": { "target": "com.amazonaws.iam#UploadServerCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#KeyPairMismatchException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedCertificateException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Uploads a server certificate entity for the AWS account. The server certificate\n entity includes a public key certificate, a private key, and an optional certificate\n chain, which should all be PEM-encoded.
\nWe recommend that you use AWS Certificate\n Manager to provision, manage, and deploy your server certificates. With ACM\n you can request a certificate, deploy it to AWS resources, and let ACM handle\n certificate renewals for you. Certificates provided by ACM are free. For more\n information about using ACM, see the AWS Certificate Manager User Guide.
\nFor more information about working with server certificates, see Working\n with server certificates in the IAM User Guide. This\n topic includes a list of AWS services that can use the server certificates that you\n manage with IAM.
\nFor information about the number of server certificates you can upload, see IAM and STS\n quotas in the IAM User Guide.
\nBecause the body of the public key certificate, private key, and the certificate\n chain can be large, you should use POST rather than GET when calling\n UploadServerCertificate
. For information about setting up\n signatures and authorization through the API, see Signing AWS API\n requests in the AWS General Reference. For general\n information about using the Query API with IAM, see Calling the API by making HTTP query\n requests in the IAM User Guide.
The path for the server certificate. For more information about paths, see IAM\n identifiers in the IAM User Guide.
\nThis parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its regex pattern) a string of characters consisting \n of either a forward slash (/) by itself or a string that must begin and end with forward slashes.\n In addition, it can contain any ASCII character from the ! (\\u0021
) through the DEL character (\\u007F
), including \n most punctuation characters, digits, and upper and lowercased letters.
If you are uploading a server certificate specifically for use with Amazon\n CloudFront distributions, you must specify a path using the path
\n parameter. The path must begin with /cloudfront
and must include a\n trailing slash (for example, /cloudfront/test/
).
The name for the server certificate. Do not include the path in this value. The name\n of the certificate cannot contain any spaces.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
", "smithy.api#required": {} } }, "CertificateBody": { "target": "com.amazonaws.iam#certificateBodyType", "traits": { "smithy.api#documentation": "The contents of the public key certificate in PEM-encoded format.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
The contents of the private key in PEM-encoded format.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
The contents of the certificate chain. This is typically a concatenation of the\n PEM-encoded public key certificates of the chain.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
A list of tags that you want to attach to the new IAM server certificate resource.\n Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
\nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request \n fails and the resource is not created.
\nThe meta information of the uploaded server certificate without its certificate body,\n certificate chain, and private key.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key.\n For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful UploadServerCertificate\n request.
" } }, "com.amazonaws.iam#UploadSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UploadSigningCertificateRequest" }, "output": { "target": "com.amazonaws.iam#UploadSigningCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iam#DuplicateCertificateException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#InvalidCertificateException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#MalformedCertificateException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Uploads an X.509 signing certificate and associates it with the specified IAM user.\n Some AWS services require you to use certificates to validate requests that are signed\n with a corresponding private key. When you upload the certificate, its default status is\n Active
.
For information about when you would use an X.509 signing certificate, see Managing\n server certificates in IAM in the\n IAM User Guide.
\nIf the UserName
is not specified, the IAM user name is determined\n implicitly based on the AWS access key ID used to sign the request. This operation\n works for access keys under the AWS account. Consequently, you can use this operation\n to manage AWS account root user credentials even if the AWS account has no\n associated users.
Because the body of an X.509 certificate can be large, you should use POST rather\n than GET when calling UploadSigningCertificate
. For information about\n setting up signatures and authorization through the API, see Signing\n AWS API requests in the AWS General Reference. For\n general information about using the Query API with IAM, see Making query\n requests in the IAM User Guide.
The name of the user the signing certificate is for.
\nThis parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric \n characters with no spaces. You can also include any of the following characters: _+=,.@-
" } }, "CertificateBody": { "target": "com.amazonaws.iam#certificateBodyType", "traits": { "smithy.api#documentation": "The contents of the signing certificate.
\nThe regex pattern \n used to validate this parameter is a string of characters consisting of the following:
\nAny printable ASCII \n 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 \n (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and \n carriage return (\\u000D
)
Information about the certificate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful UploadSigningCertificate\n request.
" } }, "com.amazonaws.iam#User": { "type": "structure", "members": { "Path": { "target": "com.amazonaws.iam#pathType", "traits": { "smithy.api#documentation": "The path to the user. For more information about paths, see IAM identifiers in the\n IAM User Guide.
\nThe ARN of the policy used to set the permissions boundary for the user.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The friendly name identifying the user.
", "smithy.api#required": {} } }, "UserId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs\n and how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.
", "smithy.api#required": {} } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the user was created.
", "smithy.api#required": {} } }, "PasswordLastUsed": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the user's password was last used to sign in to an AWS website. For\n a list of AWS websites that capture a user's last sign-in time, see the Credential\n reports topic in the IAM User Guide. If a password is\n used more than once in a five-minute span, only the first use is returned in this field. If\n the field is null (no value), then it indicates that they never signed in with a password.\n This can be because:
\nThe user never had a password.
\nA password exists but has not been used since IAM started tracking this\n information on October 20, 2014.
\nA null value does not mean that the user never had a password.\n Also, if the user does not currently have a password but had one in the past, then this\n field contains the date and time the most recent password was used.
\nThis value is returned only in the GetUser and ListUsers operations.
" } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { "smithy.api#documentation": "For more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM user entity.
\nThis data type is used as a response element in the following operations:
\n\n CreateUser\n
\n\n GetUser\n
\n\n ListUsers\n
\nThe path to the user. For more information about paths, see IAM identifiers in the\n IAM User Guide.
" } }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The friendly name identifying the user.
" } }, "UserId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The stable and unique string identifying the user. For more information about IDs, see\n IAM\n identifiers in the IAM User Guide.
" } }, "Arn": { "target": "com.amazonaws.iam#arnType" }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the user was created.
" } }, "UserPolicyList": { "target": "com.amazonaws.iam#policyDetailListType", "traits": { "smithy.api#documentation": "A list of the inline policies embedded in the user.
" } }, "GroupList": { "target": "com.amazonaws.iam#groupNameListType", "traits": { "smithy.api#documentation": "A list of IAM groups that the user is in.
" } }, "AttachedManagedPolicies": { "target": "com.amazonaws.iam#attachedPoliciesListType", "traits": { "smithy.api#documentation": "A list of the managed policies attached to the user.
" } }, "PermissionsBoundary": { "target": "com.amazonaws.iam#AttachedPermissionsBoundary", "traits": { "smithy.api#documentation": "The ARN of the policy used to set the permissions boundary for the user.
\nFor more information about permissions boundaries, see Permissions boundaries for IAM\n identities in the IAM User Guide.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an IAM user, including all the user's policies and all the\n IAM groups the user is in.
\nThis data type is used as a response element in the GetAccountAuthorizationDetails operation.
" } }, "com.amazonaws.iam#VirtualMFADevice": { "type": "structure", "members": { "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "The serial number associated with VirtualMFADevice
.
The base32 seed defined as specified in RFC3548. The Base32StringSeed
is base64-encoded.
A QR code PNG image that encodes\n otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
\n where $virtualMFADeviceName
is one of the create call arguments.\n AccountName
is the user name if set (otherwise, the account ID otherwise),\n and Base32String
is the seed in base32 format. The Base32String
\n value is base64-encoded.
The IAM user associated with this virtual MFA device.
" } }, "EnableDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time on which the virtual MFA device was enabled.
" } }, "Tags": { "target": "com.amazonaws.iam#tagListType", "traits": { "smithy.api#documentation": "A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a virtual MFA device.
" } }, "com.amazonaws.iam#accessKeyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 16, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.iam#accessKeyMetadataListType": { "type": "list", "member": { "target": "com.amazonaws.iam#AccessKeyMetadata" }, "traits": { "smithy.api#documentation": "Contains a list of access key metadata.
\nThis data type is used as a response element in the ListAccessKeys\n operation.
" } }, "com.amazonaws.iam#accessKeySecretType": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.iam#accountAliasListType": { "type": "list", "member": { "target": "com.amazonaws.iam#accountAliasType" } }, "com.amazonaws.iam#accountAliasType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" } }, "com.amazonaws.iam#arnType": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
\nFor more information about ARNs, go to Amazon Resource Names (ARNs) in\n the AWS General Reference.
", "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.iam#assignmentStatusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Assigned", "name": "Assigned" }, { "value": "Unassigned", "name": "Unassigned" }, { "value": "Any", "name": "Any" } ] } }, "com.amazonaws.iam#attachedPoliciesListType": { "type": "list", "member": { "target": "com.amazonaws.iam#AttachedPolicy" } }, "com.amazonaws.iam#attachmentCountType": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iam#authenticationCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 6 }, "smithy.api#pattern": "^[\\d]+$" } }, "com.amazonaws.iam#booleanObjectType": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iam#booleanType": { "type": "boolean" }, "com.amazonaws.iam#certificateBodyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#certificateChainType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2097152 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#certificateIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 24, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.iam#certificateListType": { "type": "list", "member": { "target": "com.amazonaws.iam#SigningCertificate" }, "traits": { "smithy.api#documentation": "Contains a list of signing certificates.
\nThis data type is used as a response element in the ListSigningCertificates operation.
" } }, "com.amazonaws.iam#clientIDListType": { "type": "list", "member": { "target": "com.amazonaws.iam#clientIDType" } }, "com.amazonaws.iam#clientIDType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.iam#credentialReportExpiredExceptionMessage": { "type": "string" }, "com.amazonaws.iam#credentialReportNotPresentExceptionMessage": { "type": "string" }, "com.amazonaws.iam#credentialReportNotReadyExceptionMessage": { "type": "string" }, "com.amazonaws.iam#customSuffixType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#dateType": { "type": "timestamp" }, "com.amazonaws.iam#deleteConflictMessage": { "type": "string" }, "com.amazonaws.iam#duplicateCertificateMessage": { "type": "string" }, "com.amazonaws.iam#duplicateSSHPublicKeyMessage": { "type": "string" }, "com.amazonaws.iam#encodingType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SSH", "name": "SSH" }, { "value": "PEM", "name": "PEM" } ] } }, "com.amazonaws.iam#entityAlreadyExistsMessage": { "type": "string" }, "com.amazonaws.iam#entityDetailsListType": { "type": "list", "member": { "target": "com.amazonaws.iam#EntityDetails" } }, "com.amazonaws.iam#entityListType": { "type": "list", "member": { "target": "com.amazonaws.iam#EntityType" } }, "com.amazonaws.iam#entityNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#entityTemporarilyUnmodifiableMessage": { "type": "string" }, "com.amazonaws.iam#existingUserNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#globalEndpointTokenVersion": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "v1Token", "name": "v1Token" }, { "value": "v2Token", "name": "v2Token" } ] } }, "com.amazonaws.iam#groupDetailListType": { "type": "list", "member": { "target": "com.amazonaws.iam#GroupDetail" } }, "com.amazonaws.iam#groupListType": { "type": "list", "member": { "target": "com.amazonaws.iam#Group" }, "traits": { "smithy.api#documentation": "Contains a list of IAM groups.
\nThis data type is used as a response element in the ListGroups\n operation.
" } }, "com.amazonaws.iam#groupNameListType": { "type": "list", "member": { "target": "com.amazonaws.iam#groupNameType" } }, "com.amazonaws.iam#groupNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#idType": { "type": "string", "traits": { "smithy.api#length": { "min": 16, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.iam#instanceProfileListType": { "type": "list", "member": { "target": "com.amazonaws.iam#InstanceProfile" }, "traits": { "smithy.api#documentation": "Contains a list of instance profiles.
" } }, "com.amazonaws.iam#instanceProfileNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#integerType": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iam#invalidAuthenticationCodeMessage": { "type": "string" }, "com.amazonaws.iam#invalidCertificateMessage": { "type": "string" }, "com.amazonaws.iam#invalidInputMessage": { "type": "string" }, "com.amazonaws.iam#invalidPublicKeyMessage": { "type": "string" }, "com.amazonaws.iam#invalidUserTypeMessage": { "type": "string" }, "com.amazonaws.iam#jobIDType": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 } } }, "com.amazonaws.iam#jobStatusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.iam#keyPairMismatchMessage": { "type": "string" }, "com.amazonaws.iam#limitExceededMessage": { "type": "string" }, "com.amazonaws.iam#listPolicyGrantingServiceAccessResponseListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ListPoliciesGrantingServiceAccessEntry" } }, "com.amazonaws.iam#malformedCertificateMessage": { "type": "string" }, "com.amazonaws.iam#malformedPolicyDocumentMessage": { "type": "string" }, "com.amazonaws.iam#markerType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 320 }, "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#maxItemsType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iam#maxPasswordAgeType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1095 } } }, "com.amazonaws.iam#mfaDeviceListType": { "type": "list", "member": { "target": "com.amazonaws.iam#MFADevice" }, "traits": { "smithy.api#documentation": "Contains a list of MFA devices.
\nThis data type is used as a response element in the ListMFADevices and\n ListVirtualMFADevices operations.
" } }, "com.amazonaws.iam#minimumPasswordLengthType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 6, "max": 128 } } }, "com.amazonaws.iam#noSuchEntityMessage": { "type": "string" }, "com.amazonaws.iam#organizationsEntityPathType": { "type": "string", "traits": { "smithy.api#length": { "min": 19, "max": 427 }, "smithy.api#pattern": "^o-[0-9a-z]{10,32}\\/r-[0-9a-z]{4,32}[0-9a-z-\\/]*$" } }, "com.amazonaws.iam#organizationsPolicyIdType": { "type": "string", "traits": { "smithy.api#pattern": "^p-[0-9a-zA-Z_]{8,128}$" } }, "com.amazonaws.iam#passwordPolicyViolationMessage": { "type": "string" }, "com.amazonaws.iam#passwordReusePreventionType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 24 } } }, "com.amazonaws.iam#passwordType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.iam#pathPrefixType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^\\u002F[\\u0021-\\u007F]*$" } }, "com.amazonaws.iam#pathType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)$" } }, "com.amazonaws.iam#policyDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.iam#policyDetailListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyDetail" } }, "com.amazonaws.iam#policyDocumentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 131072 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#policyDocumentVersionListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyVersion" } }, "com.amazonaws.iam#policyEvaluationErrorMessage": { "type": "string" }, "com.amazonaws.iam#policyGrantingServiceAccessListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyGrantingServiceAccess" } }, "com.amazonaws.iam#policyListType": { "type": "list", "member": { "target": "com.amazonaws.iam#Policy" } }, "com.amazonaws.iam#policyNameListType": { "type": "list", "member": { "target": "com.amazonaws.iam#policyNameType" }, "traits": { "smithy.api#documentation": "Contains a list of policy names.
\nThis data type is used as a response element in the ListPolicies\n operation.
" } }, "com.amazonaws.iam#policyNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#policyNotAttachableMessage": { "type": "string" }, "com.amazonaws.iam#policyOwnerEntityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "USER", "name": "USER" }, { "value": "ROLE", "name": "ROLE" }, { "value": "GROUP", "name": "GROUP" } ] } }, "com.amazonaws.iam#policyPathType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^((/[A-Za-z0-9\\.,\\+@=_-]+)*)/$" } }, "com.amazonaws.iam#policyScopeType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "All", "name": "All" }, { "value": "AWS", "name": "AWS" }, { "value": "Local", "name": "Local" } ] } }, "com.amazonaws.iam#policyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INLINE", "name": "INLINE" }, { "value": "MANAGED", "name": "MANAGED" } ] } }, "com.amazonaws.iam#policyVersionIdType": { "type": "string", "traits": { "smithy.api#pattern": "^v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?$" } }, "com.amazonaws.iam#privateKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.iam#publicKeyFingerprintType": { "type": "string", "traits": { "smithy.api#length": { "min": 48, "max": 48 }, "smithy.api#pattern": "^[:\\w]+$" } }, "com.amazonaws.iam#publicKeyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.iam#publicKeyMaterialType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 16384 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#reportGenerationLimitExceededMessage": { "type": "string" }, "com.amazonaws.iam#responseMarkerType": { "type": "string" }, "com.amazonaws.iam#roleDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" } }, "com.amazonaws.iam#roleDetailListType": { "type": "list", "member": { "target": "com.amazonaws.iam#RoleDetail" } }, "com.amazonaws.iam#roleListType": { "type": "list", "member": { "target": "com.amazonaws.iam#Role" }, "traits": { "smithy.api#documentation": "Contains a list of IAM roles.
\nThis data type is used as a response element in the ListRoles\n operation.
" } }, "com.amazonaws.iam#roleMaxSessionDurationType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 3600, "max": 43200 } } }, "com.amazonaws.iam#roleNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#serialNumberType": { "type": "string", "traits": { "smithy.api#length": { "min": 9, "max": 256 }, "smithy.api#pattern": "^[\\w+=/:,.@-]+$" } }, "com.amazonaws.iam#serverCertificateMetadataListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ServerCertificateMetadata" } }, "com.amazonaws.iam#serverCertificateNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#serviceFailureExceptionMessage": { "type": "string" }, "com.amazonaws.iam#serviceName": { "type": "string" }, "com.amazonaws.iam#serviceNameType": { "type": "string" }, "com.amazonaws.iam#serviceNamespaceListType": { "type": "list", "member": { "target": "com.amazonaws.iam#serviceNamespaceType" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.iam#serviceNamespaceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\w-]*$" } }, "com.amazonaws.iam#serviceNotSupportedMessage": { "type": "string" }, "com.amazonaws.iam#servicePassword": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.iam#serviceSpecificCredentialId": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.iam#serviceUserName": { "type": "string", "traits": { "smithy.api#length": { "min": 17, "max": 200 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#sortKeyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SERVICE_NAMESPACE_ASCENDING", "name": "SERVICE_NAMESPACE_ASCENDING" }, { "value": "SERVICE_NAMESPACE_DESCENDING", "name": "SERVICE_NAMESPACE_DESCENDING" }, { "value": "LAST_AUTHENTICATED_TIME_ASCENDING", "name": "LAST_AUTHENTICATED_TIME_ASCENDING" }, { "value": "LAST_AUTHENTICATED_TIME_DESCENDING", "name": "LAST_AUTHENTICATED_TIME_DESCENDING" } ] } }, "com.amazonaws.iam#statusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Active", "name": "Active" }, { "value": "Inactive", "name": "Inactive" } ] } }, "com.amazonaws.iam#stringType": { "type": "string" }, "com.amazonaws.iam#summaryKeyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Users", "name": "Users" }, { "value": "UsersQuota", "name": "UsersQuota" }, { "value": "Groups", "name": "Groups" }, { "value": "GroupsQuota", "name": "GroupsQuota" }, { "value": "ServerCertificates", "name": "ServerCertificates" }, { "value": "ServerCertificatesQuota", "name": "ServerCertificatesQuota" }, { "value": "UserPolicySizeQuota", "name": "UserPolicySizeQuota" }, { "value": "GroupPolicySizeQuota", "name": "GroupPolicySizeQuota" }, { "value": "GroupsPerUserQuota", "name": "GroupsPerUserQuota" }, { "value": "SigningCertificatesPerUserQuota", "name": "SigningCertificatesPerUserQuota" }, { "value": "AccessKeysPerUserQuota", "name": "AccessKeysPerUserQuota" }, { "value": "MFADevices", "name": "MFADevices" }, { "value": "MFADevicesInUse", "name": "MFADevicesInUse" }, { "value": "AccountMFAEnabled", "name": "AccountMFAEnabled" }, { "value": "AccountAccessKeysPresent", "name": "AccountAccessKeysPresent" }, { "value": "AccountSigningCertificatesPresent", "name": "AccountSigningCertificatesPresent" }, { "value": "AttachedPoliciesPerGroupQuota", "name": "AttachedPoliciesPerGroupQuota" }, { "value": "AttachedPoliciesPerRoleQuota", "name": "AttachedPoliciesPerRoleQuota" }, { "value": "AttachedPoliciesPerUserQuota", "name": "AttachedPoliciesPerUserQuota" }, { "value": "Policies", "name": "Policies" }, { "value": "PoliciesQuota", "name": "PoliciesQuota" }, { "value": "PolicySizeQuota", "name": "PolicySizeQuota" }, { "value": "PolicyVersionsInUse", "name": "PolicyVersionsInUse" }, { "value": "PolicyVersionsInUseQuota", "name": "PolicyVersionsInUseQuota" }, { "value": "VersionsPerPolicyQuota", "name": "VersionsPerPolicyQuota" }, { "value": "GlobalEndpointTokenVersion", "name": "GlobalEndpointTokenVersion" } ] } }, "com.amazonaws.iam#summaryMapType": { "type": "map", "key": { "target": "com.amazonaws.iam#summaryKeyType" }, "value": { "target": "com.amazonaws.iam#summaryValueType" } }, "com.amazonaws.iam#summaryValueType": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iam#tagKeyListType": { "type": "list", "member": { "target": "com.amazonaws.iam#tagKeyType" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.iam#tagKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" } }, "com.amazonaws.iam#tagListType": { "type": "list", "member": { "target": "com.amazonaws.iam#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.iam#tagValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" } }, "com.amazonaws.iam#thumbprintListType": { "type": "list", "member": { "target": "com.amazonaws.iam#thumbprintType" }, "traits": { "smithy.api#documentation": "Contains a list of thumbprints of identity provider server certificates.
" } }, "com.amazonaws.iam#thumbprintType": { "type": "string", "traits": { "smithy.api#documentation": "Contains a thumbprint for an identity provider's server certificate.
\nThe identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash\n value of the self-signed X.509 certificate. This thumbprint is used by the domain where the\n OpenID Connect provider makes its keys available. The thumbprint is always a 40-character\n string.
", "smithy.api#length": { "min": 40, "max": 40 } } }, "com.amazonaws.iam#unmodifiableEntityMessage": { "type": "string" }, "com.amazonaws.iam#unrecognizedPublicKeyEncodingMessage": { "type": "string" }, "com.amazonaws.iam#userDetailListType": { "type": "list", "member": { "target": "com.amazonaws.iam#UserDetail" } }, "com.amazonaws.iam#userListType": { "type": "list", "member": { "target": "com.amazonaws.iam#User" }, "traits": { "smithy.api#documentation": "Contains a list of users.
\nThis data type is used as a response element in the GetGroup and ListUsers operations.
" } }, "com.amazonaws.iam#userNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#virtualMFADeviceListType": { "type": "list", "member": { "target": "com.amazonaws.iam#VirtualMFADevice" } }, "com.amazonaws.iam#virtualMFADeviceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } } } }