{
"smithy": "2.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#AcceptDelegationRequest"
},
{
"target": "com.amazonaws.iam#AcquireRole"
},
{
"target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#AddRoleToInstanceProfile"
},
{
"target": "com.amazonaws.iam#AddUserToGroup"
},
{
"target": "com.amazonaws.iam#AssociateDelegationRequest"
},
{
"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#CreateDelegationRequest"
},
{
"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#DisableOrganizationsRootCredentialsManagement"
},
{
"target": "com.amazonaws.iam#DisableOrganizationsRootSessions"
},
{
"target": "com.amazonaws.iam#DisableOutboundWebIdentityFederation"
},
{
"target": "com.amazonaws.iam#EnableMFADevice"
},
{
"target": "com.amazonaws.iam#EnableOrganizationsRootCredentialsManagement"
},
{
"target": "com.amazonaws.iam#EnableOrganizationsRootSessions"
},
{
"target": "com.amazonaws.iam#EnableOutboundWebIdentityFederation"
},
{
"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#GetAccountProperties"
},
{
"target": "com.amazonaws.iam#GetAccountSummary"
},
{
"target": "com.amazonaws.iam#GetContextKeysForCustomPolicy"
},
{
"target": "com.amazonaws.iam#GetContextKeysForPrincipalPolicy"
},
{
"target": "com.amazonaws.iam#GetCredentialReport"
},
{
"target": "com.amazonaws.iam#GetDelegationRequest"
},
{
"target": "com.amazonaws.iam#GetGroup"
},
{
"target": "com.amazonaws.iam#GetGroupPolicy"
},
{
"target": "com.amazonaws.iam#GetHumanReadableSummary"
},
{
"target": "com.amazonaws.iam#GetInstanceProfile"
},
{
"target": "com.amazonaws.iam#GetLoginProfile"
},
{
"target": "com.amazonaws.iam#GetMFADevice"
},
{
"target": "com.amazonaws.iam#GetOpenIDConnectProvider"
},
{
"target": "com.amazonaws.iam#GetOrganizationsAccessReport"
},
{
"target": "com.amazonaws.iam#GetOutboundWebIdentityFederationInfo"
},
{
"target": "com.amazonaws.iam#GetPolicy"
},
{
"target": "com.amazonaws.iam#GetPolicyVersion"
},
{
"target": "com.amazonaws.iam#GetRole"
},
{
"target": "com.amazonaws.iam#GetRolePolicy"
},
{
"target": "com.amazonaws.iam#GetRoleTemplateVersion"
},
{
"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#ListDelegationRequests"
},
{
"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#ListOrganizationsFeatures"
},
{
"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#PutAccountProperties"
},
{
"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#RejectDelegationRequest"
},
{
"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#SendDelegationToken"
},
{
"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#UpdateDelegationRequest"
},
{
"target": "com.amazonaws.iam#UpdateGroup"
},
{
"target": "com.amazonaws.iam#UpdateLoginProfile"
},
{
"target": "com.amazonaws.iam#UpdateOpenIDConnectProvider"
},
{
"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": "
Identity and Access Management (IAM) is a web service for securely controlling \n access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials\n such as access keys, and permissions that control which Amazon Web Services resources users and \n applications can access. For more information about IAM, see Identity and Access Management (IAM) and the Identity and Access Management User Guide.
\n\n Programmatic access to IAM\n
\nWe recommend that you use the Amazon Web Services SDKs to make programmatic API calls to IAM. The Amazon Web Services\n SDKs consist of libraries and sample code for various programming languages and platforms\n (for example, Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to\n create programmatic access to IAM and Amazon Web Services. For example, the SDKs take care of tasks such as\n cryptographically signing requests, managing errors, and retrying requests automatically.\n For more information, see Tools to build on\n Amazon Web Services.
\nAlternatively, you can also use the IAM Query API to make direct calls to the IAM\n service. For more information about calling the IAM Query API, see Making query\n requests in the Identity and Access Management User Guide. IAM supports GET and\n POST requests for all actions. That is, the API does not require you to use GET for some\n actions and POST for others. However, GET requests are subject to the limitation size of a\n URL. Therefore, for operations that require larger sizes, use a POST request.
\n\n Signing requests\n
\nRequests must be signed using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account access key ID and secret access key for\n everyday work with IAM. You can use the access key ID and secret access key for an\n IAM user or you can use the Security Token Service to generate temporary security credentials and use\n those to sign requests.
\nTo sign requests, we recommend that you use Signature Version 4. If you have an\n existing application that uses Signature Version 2, you do not have to update it to use\n Signature Version 4. However, some operations now require Signature Version 4. The\n documentation for operations that require version 4 indicate this requirement.
\n\n Additional resources\n
\n\n Amazon Web Services\n security credentials. This topic provides general information about the types of\n credentials used for accessing Amazon Web Services.
\n\n IAM best\n practices. This topic presents a list of suggestions for using the IAM service\n to help secure your Amazon Web Services resources.
\n\n Signing\n Amazon Web Services API requests. This set of topics walk you through the process of signing a\n request using an access key ID and secret access key.
\nAccepts a delegation request, granting the requested temporary access.
\nOnce the delegation request is accepted, it is eligible to send the exchange token to the partner.\n The SendDelegationToken\n API has to be explicitly called to send the delegation token.\n
\nAt the time of acceptance, IAM records the details and the state of the identity that called this API.\n This is the identity that gets mapped to the delegated credential.\n
\nAn accepted request may be rejected before the exchange token is sent to the partner.
" } }, "com.amazonaws.iam#AcceptDelegationRequestRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier of the delegation request to accept.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AccessAdvisorUsageGranularityType": { "type": "enum", "members": { "SERVICE_LEVEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_LEVEL" } }, "ACTION_LEVEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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 Amazon Web Services 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 Amazon Web Services\n service namespaces in the\u00a0Amazon Web Services 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 tracking 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. Amazon Web Services does not report\n unauthenticated requests.
\nThis field is null if no principals (IAM users, IAM roles, or root user) in the\n reported Organizations entity attempted to access the service within the tracking period.
" } }, "LastAuthenticatedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in\u00a0ISO 8601 date-time\n format, when an authenticated principal most recently attempted to access the\n service. Amazon Web Services 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 tracking period.
" } }, "TotalAuthenticatedEntities": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The number of accounts with authenticated principals (root user, IAM users, and IAM\n roles) that attempted to access the service in the tracking period.
" } } }, "traits": { "smithy.api#documentation": "An object that contains details about when a principal in the reported Organizations entity\n last attempted to access an Amazon Web Services service. A principal can be an IAM user, an IAM role,\n or the Amazon Web Services 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 Amazon Web Services access key.
\nThis data type is used as a response element in the CreateAccessKey and\n ListAccessKeys operations.
\nThe SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create\n an access key; you cannot recover the secret access key later. If you lose a secret\n 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 Amazon Web Services service with which this access key was most recently used. The\n value 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 Amazon Web Services Region where this access key was most recently used. The value for this field\n 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 began tracking this\n information.
\nThere is no sign-in data associated with the user.
\nFor more information about Amazon Web Services 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 Amazon Web Services 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\n 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 Amazon Web Services access key, without its secret key.
\nThis data type is used as a response element in the ListAccessKeys\n operation.
" } }, "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the account making the request is not the management\n account or delegated administrator account for centralized root\n access.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#AcquireRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#AcquireRoleRequest" }, "output": { "target": "com.amazonaws.iam#AcquireRoleResponse" }, "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#NameConflictException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#RoleModifiedException" }, { "target": "com.amazonaws.iam#RoleTemplateDisabledException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an IAM role from the specified role template. The new role takes its\n configuration\u2014including its name, path, trust policy, inline and managed policies,\n permissions boundary, tags, and maximum session duration\u2014from the role\n template version that you specify. For more information about roles, see IAM roles in the\n IAM User Guide.
\nIf the template version defines parameters, use the ReplacementValues\n parameter to supply the values that the service substitutes into the role during\n creation.
The Amazon Resource Name (ARN) of the role template to create the role from.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "TemplateMinorVersion": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The minor version of the role template to use. If you do not specify a minor version,\n the service uses the template's default minor version.
" } }, "ReplacementValues": { "target": "com.amazonaws.iam#mapStringReplacementValueEntry", "traits": { "smithy.api#documentation": "A map of values to substitute for the parameters that are defined in the role template\n version. Each key is a parameter name from the template, and each value is a structure\n that contains the replacement values for that parameter.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AcquireRoleResponse": { "type": "structure", "members": { "Role": { "target": "com.amazonaws.iam#Role", "traits": { "smithy.api#documentation": "A structure that contains details about the IAM role that was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "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" }, "output": { "target": "smithy.api#Unit" }, "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 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.
", "smithy.api#examples": [ { "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider", "documentation": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", "input": { "ClientID": "my-application-ID", "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AddRoleToInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#AddRoleToInstanceProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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.
When using the iam:AssociatedResourceArn condition in a policy to restrict the PassRole IAM action, special considerations apply if the policy is\n intended to define access for the AddRoleToInstanceProfile action. In\n this case, you cannot specify a Region or instance ID in the EC2 instance ARN. The\n ARN value must be arn:aws:ec2:*:CallerAccountId:instance/*. Using any\n other ARN value may lead to unexpected evaluation results.
For more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To add a role to an instance profile", "documentation": "The following command adds the role named S3Access to the instance profile named Webserver:", "input": { "RoleName": "S3Access", "InstanceProfileName": "Webserver" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AddUserToGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#AddUserToGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
", "smithy.api#examples": [ { "title": "To add a user to an IAM group", "documentation": "The following command adds an IAM user named Bob to the IAM group named Admins:", "input": { "UserName": "Bob", "GroupName": "Admins" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#ArnListType": { "type": "list", "member": { "target": "com.amazonaws.iam#arnType" } }, "com.amazonaws.iam#AssociateDelegationRequest": { "type": "operation", "input": { "target": "com.amazonaws.iam#AssociateDelegationRequestRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "Associates a delegation request with the current identity.
\nIf the partner that created the delegation request has specified the owner account during creation,\n only an identity from that owner account can call the AssociateDelegationRequest API for\n the specified delegation request. Once the AssociateDelegationRequest API call is successful,\n the ARN of the current calling identity will be stored as the\n ownerId\n of the request.\n
If the partner that created the delegation request has not specified the owner account during creation,\n any caller from any account can call the AssociateDelegationRequest API for\n the delegation request. Once this API call is successful, the ARN of the current calling identity will be stored as the\n ownerId\n and the Amazon Web Services account ID of the current calling identity will be stored as the\n ownerAccount\n of the request.\n
\n For more details, see\n \n Managing Permissions for Delegation Requests.\n
" } }, "com.amazonaws.iam#AssociateDelegationRequestRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier of the delegation request to associate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AttachGroupPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachGroupPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 \n PutGroupPolicy\n .
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 policies, see Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To attach a managed policy to an IAM group", "documentation": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", "input": { "GroupName": "Finance", "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" } } ] } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AttachRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachRolePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 \n CreateRole\n . You can update a role's trust policy using\n \n UpdateAssumerolePolicy\n .
Use this operation to attach a managed policy to a role. To embed\n an inline policy in a role, use \n PutRolePolicy\n . For more information about policies, see Managed\n policies and inline 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.
", "smithy.api#examples": [ { "title": "To attach a managed policy to an IAM role", "documentation": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", "input": { "RoleName": "ReadOnlyRole", "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" } } ] } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#AttachUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#AttachUserPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 \n PutUserPolicy\n .
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 policies, see Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To attach a managed policy to an IAM user", "documentation": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", "input": { "UserName": "Alice", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" } } ] } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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#AttachmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#AttachmentType": { "type": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user" } }, "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "group" } }, "ROLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "role" } } } }, "com.amazonaws.iam#BootstrapDatum": { "type": "blob", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.iam#CallerIsNotManagementAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because the account making the request is not the management\n account for the organization.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#CertificationKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#CertificationMapType": { "type": "map", "key": { "target": "com.amazonaws.iam#CertificationKeyType" }, "value": { "target": "com.amazonaws.iam#CertificationValueType" } }, "com.amazonaws.iam#CertificationValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" } }, "com.amazonaws.iam#ChangePassword": { "type": "operation", "input": { "target": "com.amazonaws.iam#ChangePasswordRequest" }, "output": { "target": "smithy.api#Unit" }, "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 CLI, the Amazon Web Services API, or the My\n Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is\n not affected by this operation.
\nUse UpdateLoginProfile\n to use the CLI, the Amazon Web Services API, or the Users page in\n the IAM console to change the password for any IAM user. For more information about\n modifying passwords, see Managing passwords in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To change the password for your IAM user", "documentation": "The following command changes the password for the current IAM user.", "input": { "NewPassword": "]35d/{pB9Fo9wJ", "OldPassword": "3s0K_;xh4~8XXI" } } ] } }, "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 Amazon Web Services 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 Amazon Web Services 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\n 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": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "string" } }, "STRING_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stringList" } }, "NUMERIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "numeric" } }, "NUMERIC_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "numericList" } }, "BOOLEAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "boolean" } }, "BOOLEAN_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "booleanList" } }, "IP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ip" } }, "IP_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipList" } }, "BINARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "binary" } }, "BINARY_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "binaryList" } }, "DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "date" } }, "DATE_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dateList" } } } }, "com.amazonaws.iam#ContextKeyValueListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ContextKeyValueType" } }, "com.amazonaws.iam#ContextKeyValueType": { "type": "string" }, "com.amazonaws.iam#ContextProvider": { "type": "structure", "members": { "KeyDefinitionList": { "target": "com.amazonaws.iam#keyDefinitionListType", "traits": { "smithy.api#documentation": "A list of source-to-target key mappings that define how keys from the external identity\n provider's assertion or token are mapped into trusted context keys. You can specify from 0\n to 10 mappings.
" } }, "SubjectSourceKey": { "target": "com.amazonaws.iam#contextProviderSourceKeyType", "traits": { "smithy.api#documentation": "The source key that is used to derive the subject for the injected trusted context. This\n value identifies the claim or attribute in the external identity provider's assertion or\n token that supplies the subject.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
A static value for the subject type, such as user or\n workload.
This parameter is optional and is mutually exclusive with\n SubjectTypeSourceKey. Specify either SubjectTypeValue or\n SubjectTypeSourceKey, but not both.
The source key that supplies the subject type from the external identity provider's\n assertion or token.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
This parameter is mutually exclusive with SubjectTypeValue. Specify either\n SubjectTypeSourceKey or SubjectTypeValue, but not both.
Contains the trusted identity propagation context provider configuration for a SAML or\n OpenID Connect (OIDC) identity provider. The context provider defines how the subject is\n derived and how keys from the external identity provider's assertion or token are mapped\n into trusted context keys.
\nThis data type is used as a request parameter in the CreateOpenIDConnectProvider, UpdateOpenIDConnectProvider, CreateSAMLProvider,\n and UpdateSAMLProvider operations, and as a response element in the GetOpenIDConnectProvider and GetSAMLProvider\n operations.
" } }, "com.amazonaws.iam#ContextProviderKeyDefinition": { "type": "structure", "members": { "SourceKey": { "target": "com.amazonaws.iam#contextProviderSourceKeyType", "traits": { "smithy.api#documentation": "The key in the external identity provider's assertion or token to read the value\n from.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
The trusted context key to map the source value into.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
Defines a single mapping from a source key in the external identity provider's assertion\n or token to a target trusted context key.
\nThis data type is used as a member of the ContextProvider data\n type.
" } }, "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 Amazon Web Services secret access key and corresponding Amazon Web Services 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 Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials. This is true even if the Amazon Web Services 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 Amazon Web Services 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: _+=,.@-
" } } }, "traits": { "smithy.api#input": {} } }, "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
", "smithy.api#output": {} } }, "com.amazonaws.iam#CreateAccountAlias": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateAccountAliasRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account\n alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.
", "smithy.api#examples": [ { "title": "To create an account alias", "documentation": "The following command associates the alias examplecorp to your AWS account.", "input": { "AccountAlias": "examplecorp" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#CreateDelegationRequest": { "type": "operation", "input": { "target": "com.amazonaws.iam#CreateDelegationRequestRequest" }, "output": { "target": "com.amazonaws.iam#CreateDelegationRequestResponse" }, "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 delegation request for temporary access delegation.
\nThis API is not available for general use. In order to use this API, a caller first need to\n go through an onboarding process described in the\n partner onboarding documentation.\n
" } }, "com.amazonaws.iam#CreateDelegationRequestRequest": { "type": "structure", "members": { "OwnerAccountId": { "target": "com.amazonaws.iam#accountIdType", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID this delegation request is targeted to.
\nIf the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by\n any account. If the account ID passed, then the created delegation request can only be associated with an\n identity of that target account.
" } }, "Description": { "target": "com.amazonaws.iam#delegationRequestDescriptionType", "traits": { "smithy.api#documentation": "A description of the delegation request.
", "smithy.api#required": {} } }, "Permissions": { "target": "com.amazonaws.iam#DelegationPermission", "traits": { "smithy.api#documentation": "The permissions to be delegated in this delegation request.
", "smithy.api#required": {} } }, "RequestMessage": { "target": "com.amazonaws.iam#requestMessageType", "traits": { "smithy.api#documentation": "A message explaining the reason for the delegation request.
\nRequesters can utilize this field to add a custom note to the delegation request. This field is different from the\n description such that this is to be utilized for a custom messaging on a case-by-case basis.
\nFor example, if the current delegation request is in response to a previous request being rejected, this explanation\n can be added to the request via this field.
" } }, "RequestorWorkflowId": { "target": "com.amazonaws.iam#requestorWorkflowIdType", "traits": { "smithy.api#documentation": "The workflow ID associated with the requestor.
\nThis is the unique identifier on the partner side that can be used to track the progress of the request.
\nIAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request\n is passed, this API call will fail.
", "smithy.api#required": {} } }, "RedirectUrl": { "target": "com.amazonaws.iam#redirectUrlType", "traits": { "smithy.api#documentation": "The URL to redirect to after the delegation request is processed.
\nThis URL is used by the IAM console to show a link to the customer to re-load the partner workflow.
" } }, "NotificationChannel": { "target": "com.amazonaws.iam#notificationChannelType", "traits": { "smithy.api#documentation": "The notification channel for updates about the delegation request.
\nAt this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting\n SNS:Publish permission to the IAM service principal (iam.amazonaws.com). See\n partner onboarding documentation for more details.\n
The duration for which the delegated session should remain active, in seconds.
\nThe active time window for the session starts when the customer calls the\n SendDelegationToken API.
", "smithy.api#required": {} } }, "OnlySendByOwner": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the delegation token should only be sent by the owner.
\nThis flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request.\n This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent\n to a more privileged user for approval due to the owner lacking sufficient delegation permissions.\n
A deep link URL to the Amazon Web Services Management Console for managing the delegation request.
\nFor a console based workflow, partners should redirect the customer to this URL.\n If the customer is not logged in to any Amazon Web Services account, the Amazon Web Services workflow will\n automatically direct the customer to log in and then display the delegation request approval page.
" } }, "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier for the created delegation request.
" } } }, "traits": { "smithy.api#output": {} } }, "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.
", "smithy.api#examples": [ { "title": "To create an IAM group", "documentation": "The following command creates an IAM group named Admins.", "input": { "GroupName": "Admins" }, "output": { "Group": { "Path": "/", "CreateDate": "2015-03-09T20:30:24.940Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" } } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
", "smithy.api#output": {} } }, "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.
", "smithy.api#examples": [ { "title": "To create an instance profile", "documentation": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", "input": { "InstanceProfileName": "Webserver" }, "output": { "InstanceProfile": { "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", "Roles": [], "CreateDate": "2015-03-09T20:33:19.626Z", "InstanceProfileName": "Webserver", "Path": "/", "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver" } } } ] } }, "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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services services through the Amazon Web Services Management Console.
\nYou can use the CLI, the Amazon Web Services API, or the Users\n page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.
\nFor more information about managing passwords, see Managing passwords in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To create an instance profile", "documentation": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", "input": { "UserName": "Bob", "Password": "h]6EszR}vJ*m", "PasswordResetRequired": true }, "output": { "LoginProfile": { "UserName": "Bob", "CreateDate": "2015-03-10T20:55:40.274Z", "PasswordResetRequired": true } } } ] } }, "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 is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the 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: _+=,.@-
" } }, "Password": { "target": "com.amazonaws.iam#passwordType", "traits": { "smithy.api#documentation": "The new password for the user.
\nThis parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.
\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 Amazon Web Services 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.
" } }, "MaxSigninSessionDuration": { "target": "com.amazonaws.iam#maxSigninSessionDurationType", "traits": { "smithy.api#documentation": "The maximum duration (in seconds) of an Amazon Web Services Sign-In session for this IAM user.\n This setting can have a value from 1 hour (3600 seconds) to 90 days (7776000 seconds),\n inclusive. If you do not specify a value, the setting remains unset and the existing\n sign-in session behavior applies.
\nThis setting is not supported for the root user.
\nA structure containing the user name and password create date.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful CreateLoginProfile\n request.
", "smithy.api#output": {} } }, "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#OpenIdIdpCommunicationErrorException" }, { "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 Amazon Web Services and\n the OIDC provider.
\nIf you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't\n need to create a separate IAM identity provider. These OIDC identity providers are\n already built-in to Amazon Web Services and are available for your use. Instead, you can move directly\n to creating new roles using your identity provider. To learn more, see Creating\n a role for web identity or OpenID connect federation in the IAM\n 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 allowed to authenticate using the OIDC provider
\nA list of tags that are attached to the specified IAM OIDC provider
\nA list of thumbprints of one or more server certificates that the IdP\n uses
\nA trusted identity propagation context provider that defines how the subject\n is derived and how keys from the provider's token are mapped into trusted\n context keys. Specifying a context provider enables trusted identity propagation\n for the provider. For more information, see ContextProvider.
\nThe ARN of an IAM Identity Center instance to associate with the OIDC\n provider. If you specify an IAM Identity Center instance, you must also\n specify a context provider.
\nYou get the URL, client IDs, and thumbprints from the OIDC IdP you want to use to\n access Amazon Web Services.
\nAmazon Web Services secures communication with OIDC identity providers (IdPs) using our library of\n trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS)\n endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed\n by one of these trusted CAs, only then we secure communication using the thumbprints set\n in the IdP's configuration.
\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.
\nTo control who can configure trusted identity propagation on an OIDC provider, use the\n iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM\n policies. The Request keys contain the values in the request. The\n Resource keys contain the values stored on the provider.
The 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. The URL\n should not contain a port number.
You cannot register the same provider multiple times in a single Amazon Web Services account. If you\n try to submit a URL that has already been used for an OpenID Connect provider in the\n Amazon Web Services account, you will get an error.
", "smithy.api#required": {} } }, "ClientIDList": { "target": "com.amazonaws.iam#clientIDListType", "traits": { "smithy.api#documentation": "Provides a list of client IDs, also known as audiences. When a mobile or web app\n registers with an OpenID Connect provider, they establish a value that identifies the\n application. This is the value that's sent as the client_id parameter on\n OAuth 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.
\nThis parameter is optional. If it is not included, IAM will retrieve and use the top\n intermediate certificate authority (CA) thumbprint of the OpenID Connect identity\n provider server certificate.
\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.
\nFor 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.\n
For more information about obtaining the OIDC provider thumbprint, see Obtaining the\n thumbprint for an OpenID Connect provider in the IAM user\n Guide.
\nIf your OIDC provider's discovery endpoint and JWKS endpoint\n (jwks_uri) use different certificates or hosts, include the\n thumbprints for both endpoints in this list.
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 trusted identity propagation context provider configuration to associate with the\n OpenID Connect (OIDC) provider. The context provider defines how the subject is derived\n and how keys from the provider's token are mapped into trusted context keys. Specifying a\n context provider enables trusted identity propagation for the provider. For more\n information, see ContextProvider.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.iam#identityCenterInstanceArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with\n the OpenID Connect (OIDC) provider. If you specify this parameter, you must also specify\n ContextProvider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#CreateOpenIDConnectProviderResponse": { "type": "structure", "members": { "OpenIDConnectProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is\n created. For more information, see OpenIDConnectProviderListEntry.
" } }, "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 request.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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.
You cannot use an asterisk (*) in the path name.
\nThe 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 CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\nTo learn more about JSON policy grammar, see Grammar of the IAM JSON\n policy language in the IAM User Guide.
\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.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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 CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\n IAM.
\nThe maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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.
" } } }, "traits": { "smithy.api#input": {} } }, "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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services account.
\nFor more information about roles, see IAM roles in the\n IAM User Guide. For information about quotas for role names\n and the number of roles you can create, see IAM and STS quotas in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To create an IAM role", "documentation": "The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.", "input": { "AssumeRolePolicyDocument": "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\".
\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": {} } }, "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 CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML\n format. 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)
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 value 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 CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI 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 maximum duration (in seconds) of an Amazon Web Services Sign-In session for users who sign in\n with this role. This setting can have a value from 1 hour (3600 seconds) to 90 days\n (7776000 seconds), inclusive. If you do not specify a value, the setting remains unset\n and the existing sign-in session behavior applies.
\nThis setting is independent of MaxSessionDuration.
The ARN of the managed policy that is used to set the permissions boundary for the\n role.
\nA permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.
\nFor more information about policy types, see Policy types\n in the IAM User Guide.
" } }, "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.
", "smithy.api#output": {} } }, "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 Amazon Web Services Management Console or one that supports API access\n to Amazon Web Services.
\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 Amazon Web Services Management Console and About SAML 2.0-based\n federation in the IAM User Guide.
\nTo control who can configure trusted identity propagation on a SAML provider, use the\n iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM\n policies. The Request keys contain the values in the request. The\n Resource keys contain the values stored on the provider.
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.
\nSpecifies the encryption setting for the SAML provider.
" } }, "AddPrivateKey": { "target": "com.amazonaws.iam#privateKeyType", "traits": { "smithy.api#documentation": "The private key generated from your external identity provider. The private key must\n be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML\n assertions.
" } }, "ContextProvider": { "target": "com.amazonaws.iam#ContextProvider", "traits": { "smithy.api#documentation": "The trusted identity propagation context provider configuration to associate with the\n SAML provider. The context provider defines how the subject is derived and how keys from\n the provider's SAML assertion are mapped into trusted context keys. Specifying a context\n provider enables trusted identity propagation for the provider. For more information,\n see ContextProvider.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.iam#identityCenterInstanceArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with\n the SAML provider. If you specify this parameter, you must also specify\n ContextProvider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#CreateSAMLProviderResponse": { "type": "structure", "members": { "SAMLProviderArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The 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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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\n object that contains details about the newly created role.
" } } }, "traits": { "smithy.api#output": {} } }, "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 reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
\nFor more information about using service-specific credentials to authenticate to an\n Amazon Web Services service, refer to the following docs:
\nFor service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access\n keys in the IAM User Guide.
\nFor service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with\n Amazon Keyspaces (for Apache Cassandra) in the\n IAM User Guide.
\nFor services that support long-term API keys, refer to API\n keys for Amazon Web Services services in the\n IAM User Guide.
\nThe 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 Amazon Web Services 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": {} } }, "CredentialAgeDays": { "target": "com.amazonaws.iam#credentialAgeDays", "traits": { "smithy.api#documentation": "The number of days until the service specific credential expires. This field is only\n valid for services that support long-term API keys and must be a positive integer. When\n not specified, the credential will not expire.
\nTo see which services support long-term API keys, refer to API keys\n for Amazon Web Services services in the\n IAM User Guide.
" } } }, "traits": { "smithy.api#input": {} } }, "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 Amazon Web Services 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.
", "smithy.api#examples": [ { "title": "To create an IAM user", "documentation": "The following create-user command creates an IAM user named Bob in the current account.", "input": { "UserName": "Bob" }, "output": { "User": { "UserName": "Bob", "Path": "/", "CreateDate": "2013-06-08T03:20:41.270Z", "UserId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } } } ] } }, "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 managed policy that is used to set the permissions boundary for the\n user.
\nA permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.
\nFor more information about policy types, see Policy types\n in the IAM User Guide.
" } }, "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.
", "smithy.api#output": {} } }, "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 Amazon Web Services account. After creating the virtual\n MFA, use EnableMFADevice to\n attach the MFA device to an IAM user. For more information about creating and working\n with virtual MFA devices, see Using a virtual MFA device in the\n 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 Amazon Web Services 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, which must be unique. Use with path to uniquely\n identify a virtual 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": {} } }, "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\n request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#CredentialReportExpiredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#credentialReportExpiredExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReportExpired", "httpResponseCode": 410 }, "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 information about credential report expiration,\n see Getting\n credential reports in the 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": { "aws.protocols#awsQueryError": { "code": "ReportNotPresent", "httpResponseCode": 410 }, "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": { "aws.protocols#awsQueryError": { "code": "ReportInProgress", "httpResponseCode": 404 }, "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" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "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 is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the 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: _+=,.@-
" } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DelegationPermission": { "type": "structure", "members": { "PolicyTemplateArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "This ARN maps to a pre-registered policy content for this partner.\n See the partner onboarding documentation to understand how to create a delegation template.
" } }, "Parameters": { "target": "com.amazonaws.iam#policyParameterListType", "traits": { "smithy.api#documentation": "A list of policy parameters that define the scope and constraints of the delegated permissions.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the permissions being delegated in a delegation request.
" } }, "com.amazonaws.iam#DelegationRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier for the delegation request.
" } }, "OwnerAccountId": { "target": "com.amazonaws.iam#accountIdType", "traits": { "smithy.api#documentation": "Amazon Web Services account ID of the owner of the delegation request.
" } }, "Description": { "target": "com.amazonaws.iam#delegationRequestDescriptionType", "traits": { "smithy.api#documentation": "Description of the delegation request. This is a message that is provided by the Amazon Web Services\n partner that filed the delegation request.
" } }, "RequestMessage": { "target": "com.amazonaws.iam#requestMessageType", "traits": { "smithy.api#documentation": "A custom message that is added to the delegation request by the partner.
\nThis element is different from the Description element such that this is a\n request specific message injected by the partner. The Description is typically\n a generic explanation of what the delegation request is targeted to do.
JSON content of the associated permission policy of this delegation request.
" } }, "RolePermissionRestrictionArns": { "target": "com.amazonaws.iam#rolePermissionRestrictionArnListType", "traits": { "smithy.api#documentation": "If the PermissionPolicy includes role creation permissions, this element will\n include the list of permissions boundary policies associated with the role creation.\n See Permissions boundaries for IAM entities\n for more details about IAM permission boundaries.\n
ARN of the owner of this delegation request.
" } }, "ApproverId": { "target": "com.amazonaws.iam#arnType" }, "State": { "target": "com.amazonaws.iam#stateType", "traits": { "smithy.api#documentation": "The state of this delegation request.
\nSee the Understanding the Request Lifecycle for an explanation of how these\n states are transitioned.
" } }, "ExpirationTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The expiry time of this delegation request
\nSee the Understanding the Request Lifecycle for\n details on the life time of a delegation request at each state.
" } }, "RequestorId": { "target": "com.amazonaws.iam#accountIdType", "traits": { "smithy.api#documentation": "Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.
" } }, "RequestorName": { "target": "com.amazonaws.iam#requestorNameType", "traits": { "smithy.api#documentation": "A friendly name of the requestor.
" } }, "CreateDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "Creation date (timestamp) of this delegation request.
" } }, "SessionDuration": { "target": "com.amazonaws.iam#sessionDurationType", "traits": { "smithy.api#documentation": "The life-time of the requested session credential.
" } }, "RedirectUrl": { "target": "com.amazonaws.iam#redirectUrlType", "traits": { "smithy.api#documentation": "A URL to be redirected to once the delegation request is approved. Partners provide this URL when\n creating the delegation request.
" } }, "Notes": { "target": "com.amazonaws.iam#notesType", "traits": { "smithy.api#documentation": "Notes added to this delegation request, if this request was updated via the\n UpdateDelegationRequest\n API.
" } }, "RejectionReason": { "target": "com.amazonaws.iam#notesType", "traits": { "smithy.api#documentation": "Reasons for rejecting this delegation request, if this request was rejected. See also\n RejectDelegationRequest\n API documentation.\n
" } }, "OnlySendByOwner": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A flag indicating whether the\n SendDelegationToken\n must be called by the owner of this delegation request. This is set by the requesting partner.
" } }, "UpdatedTime": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "Last updated timestamp of the request.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a delegation request, including its status, permissions, and associated metadata.
" } }, "com.amazonaws.iam#DeleteAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteAccessKeyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials even if the Amazon Web Services account has no associated users.
", "smithy.api#examples": [ { "title": "To delete an access key for an IAM user", "documentation": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", "input": { "UserName": "Bob", "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteAccountAlias": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteAccountAliasRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "target": "com.amazonaws.iam#LimitExceededException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services\n account alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.
", "smithy.api#examples": [ { "title": "To delete an account alias", "documentation": "The following command removes the alias mycompany from the current AWS account:", "input": { "AccountAlias": "mycompany" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteAccountPasswordPolicy": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services account. There are no parameters.
", "smithy.api#examples": [ { "title": "To delete the current account password policy", "documentation": "The following command removes the password policy from the current AWS account:" } ] } }, "com.amazonaws.iam#DeleteConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#deleteConflictMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "DeleteConflict", "httpResponseCode": 409 }, "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" }, "output": { "target": "smithy.api#Unit" }, "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" }, "output": { "target": "smithy.api#Unit" }, "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.\n For more information about policies, refer to Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To delete a policy from an IAM group", "documentation": "The following command deletes the policy named ExamplePolicy from the group named Admins:", "input": { "GroupName": "Admins", "PolicyName": "ExamplePolicy" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteInstanceProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Using\n instance profiles in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To delete an instance profile", "documentation": "The following command deletes the instance profile named ExampleInstanceProfile", "input": { "InstanceProfileName": "ExampleInstanceProfile" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteLoginProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "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 or root user, For more information, see\n Managing\n passwords for IAM users.
\nYou can use the CLI, the Amazon Web Services API, or the Users\n page in the IAM console to delete a password for any IAM user. You can use ChangePassword to update, but not delete, your own password in the\n My Security Credentials page in the\n Amazon Web Services Management Console.
\nDeleting a user's password does not prevent a user from accessing Amazon Web Services 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\n and DeleteAccessKey.
\nThe name of the user whose password you want to delete.
\nThis parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the 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: _+=,.@-
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "Deletes an OpenID Connect identity provider (IdP) resource object in IAM. Deleting the\n provider also deletes its trusted identity propagation context provider and removes any\n IAM Identity Center instance association.
\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.
" } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeletePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 list all the users, groups, and roles that a\n policy is attached to, use ListEntitiesForPolicy.
\nDelete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the\n default version. You delete the policy's default version in the next step of the\n 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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeletePolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeletePolicyVersionRequest" }, "output": { "target": "smithy.api#Unit" }, "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\n out which 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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteRoleRequest" }, "output": { "target": "smithy.api#Unit" }, "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. Unlike the Amazon Web Services Management Console, when you delete a role\n programmatically, you must delete the items attached to the role manually, or the\n deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the\n following attached items:
\nInline policies (DeleteRolePolicy)
\nAttached managed policies (DetachRolePolicy)
\nInstance profile (RemoveRoleFromInstanceProfile)
\nOptional \u2013 Delete instance profile after detaching from role for\n resource clean up (DeleteInstanceProfile)
\nMake sure that you do not have any Amazon EC2 instances running with the role you are\n 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.
\nYou cannot set the boundary for a service-linked 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteRolePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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.\n For more information about policies, refer to Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To remove a policy from an IAM role", "documentation": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", "input": { "RoleName": "Test-Role", "PolicyName": "ExamplePolicy" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSAMLProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSSHPublicKeyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteServerCertificateRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 Amazon Web Services documentation for your\n service.
\nFor more information about service-linked roles, see Roles terms and concepts: Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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/<service-principal-name>/<role-name>/<task-uuid>.
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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteSigningCertificateRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "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 Amazon Web Services access key ID signing the request. This operation works for access keys under\n the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root\n user credentials even if the Amazon Web Services account has no associated IAM users.
", "smithy.api#examples": [ { "title": "To delete a signing certificate for an IAM user", "documentation": "The following command deletes the specified signing certificate for the IAM user named Anika.", "input": { "UserName": "Anika", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteUserRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteUserPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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.\n For more information about policies, refer to Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To remove a policy from an IAM user", "documentation": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", "input": { "UserName": "Juan", "PolicyName": "ExamplePolicy" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DeleteVirtualMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#DeleteVirtualMFADeviceRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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": "enum", "members": { "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "NOT_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_STARTED" } } } }, "com.amazonaws.iam#DetachGroupPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachGroupPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DetachRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachRolePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DetachUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#DetachUserPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagement": { "type": "operation", "input": { "target": "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementRequest" }, "output": { "target": "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementResponse" }, "errors": [ { "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" }, { "target": "com.amazonaws.iam#OrganizationNotFoundException" }, { "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" } ], "traits": { "smithy.api#documentation": "Disables the management of privileged root user credentials across member accounts in\n your organization. When you disable this feature, the management account and the\n delegated administrator for IAM can no longer manage root user credentials for member\n accounts in your organization.
", "smithy.api#examples": [ { "title": "To disable the RootCredentialsManagement feature in your organization", "documentation": "The following command disables the management of privileged root user credentials across member accounts in your organization.", "output": { "OrganizationId": "o-aa111bb222", "EnabledFeatures": [ "RootSessions" ] } } ] } }, "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DisableOrganizationsRootCredentialsManagementResponse": { "type": "structure", "members": { "OrganizationId": { "target": "com.amazonaws.iam#OrganizationIdType", "traits": { "smithy.api#documentation": "The unique identifier (ID) of an organization.
" } }, "EnabledFeatures": { "target": "com.amazonaws.iam#FeaturesListType", "traits": { "smithy.api#documentation": "The features enabled for centralized root access for member accounts in your\n organization.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iam#DisableOrganizationsRootSessions": { "type": "operation", "input": { "target": "com.amazonaws.iam#DisableOrganizationsRootSessionsRequest" }, "output": { "target": "com.amazonaws.iam#DisableOrganizationsRootSessionsResponse" }, "errors": [ { "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" }, { "target": "com.amazonaws.iam#OrganizationNotFoundException" }, { "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" } ], "traits": { "smithy.api#documentation": "Disables root user sessions for privileged tasks across member accounts in your\n organization. When you disable this feature, the management account and the delegated\n administrator for IAM can no longer perform privileged tasks on member accounts in\n your organization.
", "smithy.api#examples": [ { "title": "To disable the RootSessions feature in your organization", "documentation": "The following command disables root user sessions for privileged tasks across member accounts in your organization.", "output": { "OrganizationId": "o-aa111bb222", "EnabledFeatures": [ "RootCredentialsManagement" ] } } ] } }, "com.amazonaws.iam#DisableOrganizationsRootSessionsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#DisableOrganizationsRootSessionsResponse": { "type": "structure", "members": { "OrganizationId": { "target": "com.amazonaws.iam#OrganizationIdType", "traits": { "smithy.api#documentation": "The unique identifier (ID) of an organization.
" } }, "EnabledFeatures": { "target": "com.amazonaws.iam#FeaturesListType", "traits": { "smithy.api#documentation": "The features you have enabled for centralized root access of member accounts in your\n organization.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iam#DisableOutboundWebIdentityFederation": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#FeatureDisabledException" } ], "traits": { "smithy.api#documentation": "Disables the outbound identity federation feature for your Amazon Web Services account. When disabled, IAM principals in the account cannot \n use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services. This operation \n does not affect tokens that were issued before the feature was disabled.
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": { "aws.protocols#awsQueryError": { "code": "DuplicateSSHPublicKey", "httpResponseCode": 400 }, "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" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "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.
\nEnables the management of privileged root user credentials across member accounts in your\n organization. When you enable root credentials management for centralized root access, the management account and the delegated\n administrator for IAM can manage root user credentials for member accounts in your\n organization.
\nBefore you enable centralized root access, you must have an account configured with\n the following settings:
\nYou must manage your Amazon Web Services accounts in Organizations.
\nEnable trusted access for Identity and Access Management in Organizations. For details, see\n IAM and Organizations in the Organizations User\n Guide.
\nThe unique identifier (ID) of an organization.
" } }, "EnabledFeatures": { "target": "com.amazonaws.iam#FeaturesListType", "traits": { "smithy.api#documentation": "The features you have enabled for centralized root access.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iam#EnableOrganizationsRootSessions": { "type": "operation", "input": { "target": "com.amazonaws.iam#EnableOrganizationsRootSessionsRequest" }, "output": { "target": "com.amazonaws.iam#EnableOrganizationsRootSessionsResponse" }, "errors": [ { "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" }, { "target": "com.amazonaws.iam#CallerIsNotManagementAccountException" }, { "target": "com.amazonaws.iam#OrganizationNotFoundException" }, { "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" } ], "traits": { "smithy.api#documentation": "Allows the management account or delegated administrator to perform privileged tasks\n on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management\n User Guide.
\nBefore you enable this feature, you must have an account configured with the following\n settings:
\nYou must manage your Amazon Web Services accounts in Organizations.
\nEnable trusted access for Identity and Access Management in Organizations. For details, see\n IAM and Organizations in the Organizations User\n Guide.
\nThe unique identifier (ID) of an organization.
" } }, "EnabledFeatures": { "target": "com.amazonaws.iam#FeaturesListType", "traits": { "smithy.api#documentation": "The features you have enabled for centralized root access.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iam#EnableOutboundWebIdentityFederation": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.iam#EnableOutboundWebIdentityFederationResponse" }, "errors": [ { "target": "com.amazonaws.iam#FeatureEnabledException" } ], "traits": { "smithy.api#documentation": "Enables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account \n can use the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for secure authentication with external services. \n This operation also generates a unique issuer URL for your Amazon Web Services account.
A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints \n at /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary \n for token verification.
The 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\u00a0EntityInfo object that contains details about the entity (user or\n role).
The date and time, in\u00a0ISO 8601 date-time\n format, when the authenticated entity last attempted to access Amazon Web Services. Amazon Web Services does\n not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking 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 Amazon Web Services 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\n object.
" } }, "com.amazonaws.iam#EntityTemporarilyUnmodifiableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#entityTemporarilyUnmodifiableMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "EntityTemporarilyUnmodifiable", "httpResponseCode": 409 }, "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": "enum", "members": { "User": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "User" } }, "Role": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Role" } }, "Group": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Group" } }, "LocalManagedPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LocalManagedPolicy" } }, "AWSManagedPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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 template for the simulated resource type (for example,\n arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no\n ARN format is defined for the action. This is not a specific customer-provided resource\n ARN. To find the decision for a specific resource, use\n ResourceSpecificResults.
If you previously relied on EvalResourceName to identify which specific\n resource a result applies to, you must now use the EvalResourceName field\n within individual entries in ResourceSpecificResults instead.
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.
\nIn the top-level result, this field contains the union of matched statements across all\n requested resources. Only statements that contributed to the reported decision are\n included. For per-resource matched statements, see\n ResourceSpecificResults. This field doesn't include statements from\n service control policies (SCPs). Only statements from identity-based and resource-based\n policies appear here.
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.
In the top-level result, this field contains the deduplicated set of missing context\n values across all requested resources. This field doesn't include context keys referenced\n by service control policies (SCPs). Only context keys referenced by identity-based and\n resource-based policies appear here.
" } }, "OrganizationsDecisionDetail": { "target": "com.amazonaws.iam#OrganizationsDecisionDetail", "traits": { "smithy.api#documentation": "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.
\nFor resources that don't support organization-level evaluation, this field is omitted\n from the top-level result. For per-resource details, see\n ResourceSpecificResults.
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.
\nIn the top-level result, this map reports the most restrictive decision per policy\n type across all requested resources.
\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, Amazon Web Services 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 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 .
The simulator now returns a single EvaluationResult per action,\n regardless of how many resource ARNs are provided. Previously, simulating one action\n against N resources returned N evaluation results, each containing the same aggregate\n decision. The top-level fields (EvalDecision,\n MatchedStatements, MissingContextValues,\n EvalDecisionDetails) now represent the\n aggregate decision across all requested resources. The top-level\n EvalDecision reflects the most restrictive decision across all resources\n (for example, if any resource produces explicitDeny, the top-level\n decision is explicitDeny).
To see the decision for each individual resource, use\n ResourceSpecificResults. If your application parses evaluation results per\n resource ARN, update your code to read per-resource decisions from\n ResourceSpecificResults rather than from the top-level result.
The request failed because outbound identity federation is already disabled for your Amazon Web Services account. You cannot disable the feature multiple times
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iam#FeatureDisabledMessage": { "type": "string" }, "com.amazonaws.iam#FeatureEnabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#FeatureEnabledMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "FeatureEnabled", "httpResponseCode": 409 }, "smithy.api#documentation": "The request failed because outbound identity federation is already enabled for your Amazon Web Services account. You\n cannot enable the feature multiple times. To fetch the current configuration (including the unique issuer URL), use the GetOutboundWebIdentityFederationInfo operation.
Generates a credential report for the Amazon Web Services 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 request.
", "smithy.api#output": {} } }, "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 Organizations. You can generate a\n report for any entities (organization root, organizational unit, or account) or policies\n in your organization.
\nTo call this operation, you must be signed in using your Organizations management account\n credentials. You can use your long-term IAM user or root user credentials, or temporary\n credentials from assuming an IAM role. SCPs must be enabled for your organization\n root. You must have the required IAM and Organizations permissions. For more information, see\n Refining permissions using 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 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 Amazon Web Services, not just the successful ones. This\n includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services 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 and test the\n JobStatus response parameter. When the job is complete, you can\n retrieve the report.
To generate a service last accessed data report for entities, specify an entity path\n without specifying the optional Organizations policy ID. The type of entity that you specify\n determines the data returned in the report.
\n\n Root \u2013 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 \u2013 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 \u2013 When you specify the\n management account, the resulting report lists all Amazon Web Services 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 \u2013 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 Organizations policy ID. The type of entity that you specify determines the data\n returned for each service.
\n\n Root \u2013 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 \u2013 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 \u2013 When you specify the\n management account, the resulting report lists all Amazon Web Services 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 \u2013 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.
", "smithy.api#examples": [ { "title": "To generate a service last accessed data report for an organizational unit", "documentation": "The following operation generates a report for the organizational unit ou-rge0-awexample", "input": { "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example" }, "output": { "JobId": "examplea-1234-b567-cde8-90fg123abcd4" } } ] } }, "com.amazonaws.iam#GenerateOrganizationsAccessReportRequest": { "type": "structure", "members": { "EntityPath": { "target": "com.amazonaws.iam#organizationsEntityPathType", "traits": { "smithy.api#documentation": "The path of the Organizations entity (root, OU, or account). You can build an entity path\n using the known structure of your organization. For example, assume that your account ID\n is 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 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 Amazon Web Services service.
" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Web Services services. Recent activity\n usually appears within four hours. IAM reports activity for at least the last 400\n days, or less if your Region began supporting this feature within the last year. For\n more information, see Regions where data is tracked. For more information about services and\n actions for which action last accessed information is displayed, see IAM\n action last accessed information services and actions.
\nThe service last accessed data includes all attempts to access an Amazon Web Services API, not\n just the successful ones. This includes all attempts that were made using the\n Amazon Web Services Management Console, the Amazon Web Services 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 \u2013 Use this operation for\n users, groups, roles, or policies to list every Amazon Web Services service that the resource\n could access using permissions policies. For each service, the response includes\n 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 \u2013 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 Amazon Web Services 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, Organizations policies, IAM permissions\n boundaries, and STS assume role policies. It only applies permissions policy\n 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.
", "smithy.api#examples": [ { "title": "To generate a service last accessed data report for a policy", "documentation": "The following operation generates a report for the policy: ExamplePolicy1", "input": { "Arn": "arn:aws:iam::123456789012:policy/ExamplePolicy1" }, "output": { "JobId": "examplef-1305-c245-eba4-71fe298bcda7" } } ] } }, "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 Amazon Web Services\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.
" } } }, "traits": { "smithy.api#input": {} } }, "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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetAccessKeyLastUsedResponse": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#existingUserNameType", "traits": { "smithy.api#documentation": "The name of the 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\n request. It is also returned as a member of the AccessKeyMetaData structure\n returned by the ListAccessKeys action.
", "smithy.api#output": {} } }, "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 Amazon Web Services\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, and some SDKs do this decoding \n automatically.
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#default": false, "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 request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetAccountPasswordPolicy": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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.
", "smithy.api#examples": [ { "title": "To see the current account password policy", "documentation": "The following command displays details about the password policy for the current AWS account.", "output": { "PasswordPolicy": { "AllowUsersToChangePassword": false, "RequireNumbers": true, "RequireLowercaseCharacters": false, "RequireUppercaseCharacters": false, "MinimumPasswordLength": 8, "RequireSymbols": true, "ExpirePasswords": false, "PasswordReusePrevention": 12, "MaxPasswordAge": 90, "HardExpiry": false } } } ] } }, "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 request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetAccountProperties": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetAccountPropertiesRequest" }, "output": { "target": "com.amazonaws.iam#GetAccountPropertiesResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves the account-level properties for the caller's Amazon Web Services account. Account\n properties are configuration settings that control account-wide IAM features such as\n Role Manager.
\nThe service returns properties as key-value pairs in\n Namespace/PropertyName format. Each namespace groups related\n configuration settings. Use PutAccountProperties to modify these properties.
A map of account property key-value pairs. Keys are in the format\n Namespace/PropertyName.
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services\n account.
\nFor information about IAM quotas, see IAM and STS quotas in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To get information about IAM entity quotas and usage in the current account", "documentation": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", "output": { "SummaryMap": { "Users": 27, "UsersQuota": 5000, "Groups": 15, "GroupsQuota": 100, "Policies": 8, "PoliciesQuota": 1000, "PolicySizeQuota": 5120, "PolicyVersionsInUse": 22, "PolicyVersionsInUseQuota": 10000, "VersionsPerPolicyQuota": 5, "ServerCertificates": 1, "ServerCertificatesQuota": 20, "UserPolicySizeQuota": 2048, "GroupPolicySizeQuota": 5120, "GroupsPerUserQuota": 10, "GlobalEndpointTokenVersion": 2, "SigningCertificatesPerUserQuota": 2, "AccessKeysPerUserQuota": 2, "MFADevices": 6, "MFADevicesInUse": 3, "AccountMFAEnabled": 0, "AccountAccessKeysPresent": 1, "AccountSigningCertificatesPresent": 0, "AttachedPoliciesPerGroupQuota": 10, "AttachedPoliciesPerRoleQuota": 10, "AttachedPoliciesPerUserQuota": 10 } } } ] } }, "com.amazonaws.iam#GetAccountSummaryResponse": { "type": "structure", "members": { "SummaryMap": { "target": "com.amazonaws.iam#summaryMapType", "traits": { "smithy.api#documentation": "A set of key\u2013value pairs containing information about IAM entity usage and\n IAM quotas.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetAccountSummary request.\n
", "smithy.api#output": {} } }, "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 Amazon Web Services 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 parameters are shown in unencoded form\n here for clarity but must be URL encoded to be included as a part of a real HTML\n 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 Amazon Web Services 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\n you must supply when you call SimulatePrincipalPolicy. This operation doesn't return context keys\n referenced by service control policies (SCPs). Only context keys referenced by the\n identity-based policies attached to the specified entity, and any additional policies\n that you provide, are included.
" } }, "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 Amazon Web Services 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 Amazon Web Services 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\n request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetDelegationRequest": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetDelegationRequestRequest" }, "output": { "target": "com.amazonaws.iam#GetDelegationRequestResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a specific delegation request.
\n\n If a delegation request has no owner or owner account, GetDelegationRequest for that delegation request can be called by any account.\n If the owner account is assigned but there is\n no owner id, only identities within that owner account can call GetDelegationRequest\n for the delegation request. Once the delegation request is fully owned, the owner of the request gets\n a default permission to get that delegation request. For more details, see\n \n Managing Permissions for Delegation Requests.\n
The unique identifier of the delegation request to retrieve.
", "smithy.api#required": {} } }, "DelegationPermissionCheck": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether to perform a permission check for the delegation request.
\nIf set to true, the GetDelegationRequest API call will start a permission check process. This process\n calculates whether the caller has sufficient permissions to cover the asks from this delegation request.
Setting this parameter to true does not guarantee an answer in the response. See the PermissionCheckStatus\n and the PermissionCheckResult response attributes for further details.
The delegation request object containing all details about the request.
" } }, "PermissionCheckStatus": { "target": "com.amazonaws.iam#permissionCheckStatusType", "traits": { "smithy.api#documentation": "The status of the permission check for the delegation request.
\nThis value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request.\n Since this is an asynchronous process, there are three potential values:
\n\n IN_PROGRESS : The permission check process has started.
\n COMPLETED : The permission check process has completed. The PermissionCheckResult will include the result.
\n FAILED : The permission check process has failed.
The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions.\n This is an approximate result.
\n\n ALLOWED : The caller has sufficient permissions cover all the requested permissions.
\n DENIED : The caller does not have sufficient permissions to cover all the requested permissions.
\n UNSURE : It is not possible to determine whether the caller has all the permissions needed.\n This output is most likely for cases when the caller has permissions with conditions.
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, and some SDKs do this decoding \n automatically.
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 determine the\n 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetGroupPolicy request.\n
", "smithy.api#output": {} } }, "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#default": false, "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.
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetHumanReadableSummary": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetHumanReadableSummaryRequest" }, "output": { "target": "com.amazonaws.iam#GetHumanReadableSummaryResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves a human readable summary for a given entity. At this time, the only supported\n entity type is delegation-request\n
This method uses a Large Language Model (LLM) to generate the summary.
\n\n If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account.\n If the owner account is assigned but there is\n no owner id, only identities within that owner account can call GetHumanReadableSummary\n for the delegation request to retrieve a summary of that request.\n Once the delegation request is fully owned, the owner of the request gets\n a default permission to get that delegation request. For more details, read\n default permissions granted to delegation requests. These rules are identical to\n GetDelegationRequest\n API behavior, such that a party who has permissions to call\n GetDelegationRequest\n for a given delegation request will always be able to retrieve the human readable summary for that request.\n
Arn of the entity to be summarized. At this time, the only supported\n entity type is delegation-request\n
A string representing the locale to use for the summary generation. The\n supported locale strings are based on the \n Supported languages of the Amazon Web Services Management Console\n .
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetHumanReadableSummaryResponse": { "type": "structure", "members": { "SummaryContent": { "target": "com.amazonaws.iam#summaryContentType", "traits": { "smithy.api#documentation": "Summary content in the specified locale. Summary content is non-empty only if the\n SummaryState is AVAILABLE.
The locale that this response was generated for. This maps to the input locale.
" } }, "SummaryState": { "target": "com.amazonaws.iam#summaryStateType", "traits": { "smithy.api#documentation": "State of summary generation. This generation process is asynchronous and this attribute indicates the\n state of the generation process.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Using\n instance profiles in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To get information about an instance profile", "documentation": "The following command gets information about the instance profile named ExampleInstanceProfile.", "input": { "InstanceProfileName": "ExampleInstanceProfile" }, "output": { "InstanceProfile": { "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", "Roles": [ { "AssumeRolePolicyDocument": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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\n request.
", "smithy.api#output": {} } }, "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 for the specified IAM user. A login profile is created when\n you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist\n or does not have a password, the operation returns a 404 (NoSuchEntity)\n error.
If you create an IAM user with access to the console, the CreateDate\n reflects the date you created the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password\n for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial\n password creation date. A user with programmatic access does not have a login profile\n unless you create a password for the user to access the Amazon Web Services Management Console.
The name of the user whose login profile you want to retrieve.
\nThis parameter is optional. If no user name is included, it defaults to the principal\n making the request. When you make this request with root user credentials, you must use\n an AssumeRoot session to omit the 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: _+=,.@-
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetLoginProfileResponse": { "type": "structure", "members": { "LoginProfile": { "target": "com.amazonaws.iam#LoginProfile", "traits": { "smithy.api#documentation": "A structure containing the user name and the profile creation date for the\n user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetLoginProfile request.\n
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetMFADeviceRequest" }, "output": { "target": "com.amazonaws.iam#GetMFADeviceResponse" }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an MFA device for a specified user.
" } }, "com.amazonaws.iam#GetMFADeviceRequest": { "type": "structure", "members": { "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The friendly name identifying the user.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetMFADeviceResponse": { "type": "structure", "members": { "UserName": { "target": "com.amazonaws.iam#userNameType", "traits": { "smithy.api#documentation": "The friendly name identifying the user.
" } }, "SerialNumber": { "target": "com.amazonaws.iam#serialNumberType", "traits": { "smithy.api#documentation": "Serial number that uniquely identifies the MFA device. For this API, we only accept\n FIDO security key ARNs.
", "smithy.api#required": {} } }, "EnableDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date that a specified user's MFA device was first enabled.
" } }, "Certifications": { "target": "com.amazonaws.iam#CertificationMapType", "traits": { "smithy.api#documentation": "The certifications of a specified user's MFA device. We currently provide FIPS-140-2,\n FIPS-140-3, and FIDO certification levels obtained from FIDO Alliance Metadata Service\n (MDS).
" } } }, "traits": { "smithy.api#output": {} } }, "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.
", "smithy.api#examples": [ { "title": "To get information about an OIDC provider", "documentation": "The following example returns the configuration of an OIDC provider, including its trusted identity propagation context provider and the associated IAM Identity Center instance.", "input": { "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" }, "output": { "Url": "server.example.com", "ClientIDList": [ "my-application-id" ], "ThumbprintList": [ "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE" ], "CreateDate": "2026-11-01T17:22:18Z", "Tags": [], "ContextProvider": { "SubjectSourceKey": "sub", "SubjectTypeValue": "user", "KeyDefinitionList": [ { "SourceKey": "department", "TargetKey": "department" } ] }, "IdentityCenterInstanceArn": "arn:aws:sso:::instance/ssoins-1234567890abcdef", "IdentityStoreArn": "arn:aws:identitystore::123456789012:identitystore/d-1234567890" } } ] } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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 Amazon Web Services 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.
" } }, "ContextProvider": { "target": "com.amazonaws.iam#ContextProvider", "traits": { "smithy.api#documentation": "The trusted identity propagation context provider configuration associated with the IAM\n OIDC provider resource object. For more information, see ContextProvider.
\nThis element is returned only when a trusted identity propagation context provider is configured for the OIDC provider.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.iam#identityCenterInstanceArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance associated with\n the IAM OIDC provider resource object.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
\nThis element is returned only when an IAM Identity Center instance is associated with the OIDC provider.
" } }, "IdentityStoreArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity store that is resolved from the\n associated IAM Identity Center instance.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
\nThis element is returned only when an IAM Identity Center instance is associated with the OIDC provider.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetOpenIDConnectProvider request.
", "smithy.api#output": {} } }, "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 Organizations that was previously\n generated using the \n GenerateOrganizationsAccessReport\n operation. This operation\n 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 user, IAM users, or IAM roles)\n could access using SCPs, the operation returns details about the most recent access\n attempt. If there was no attempt, the service is listed without details about the most\n recent attempt to access the service. If the operation fails, it returns the reason that\n it failed.
\nBy default, the list is sorted by service namespace.
", "smithy.api#examples": [ { "title": "To get details from a previously generated organizational unit report", "documentation": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4", "input": { "JobId": "examplea-1234-b567-cde8-90fg123abcd4" }, "output": { "IsTruncated": false, "JobCompletionDate": "2019-06-18T19:47:35.241Z", "JobCreationDate": "2019-06-18T19:47:31.466Z", "JobStatus": "COMPLETED", "NumberOfServicesAccessible": 3, "NumberOfServicesNotAccessed": 1, "AccessDetails": [ { "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333", "LastAuthenticatedTime": "2019-05-25T16:29:52Z", "Region": "us-east-1", "ServiceName": "Amazon DynamoDB", "ServiceNamespace": "dynamodb", "TotalAuthenticatedEntities": 2 }, { "EntityPath": "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012", "LastAuthenticatedTime": "2019-06-15T13:12:06Z", "Region": "us-east-1", "ServiceName": "AWS Identity and Access Management", "ServiceNamespace": "iam", "TotalAuthenticatedEntities": 4 }, { "ServiceName": "Amazon Simple Storage Service", "ServiceNamespace": "s3", "TotalAuthenticatedEntities": 0 } ] } } ] } }, "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.
" } } }, "traits": { "smithy.api#input": {} } }, "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#default": false, "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 the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your \n Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.
" } }, "com.amazonaws.iam#GetOutboundWebIdentityFederationInfoResponse": { "type": "structure", "members": { "IssuerIdentifier": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "A unique issuer URL for your Amazon Web Services account that hosts the OpenID Connect (OIDC) discovery endpoints at \n /.well-known/openid-configuration and /.well-known/jwks.json. The OpenID Connect (OIDC) discovery endpoints contain verification keys and metadata necessary for token verification.
Indicates whether outbound identity federation is currently enabled for your \n Amazon Web Services account. When true, IAM principals in the account can call the GetWebIdentityToken API to obtain JSON Web Tokens (JWTs) for authentication with external services.
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 returns metadata about the policy. To\n retrieve the actual policy document for a specific 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\n GetRolePolicy.
\nFor more information about policies, see Managed policies and inline\n policies in the IAM User Guide.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.waiters#waitable": { "PolicyExists": { "acceptors": [ { "state": "success", "matcher": { "success": true } }, { "state": "retry", "matcher": { "errorType": "NoSuchEntity" } } ], "minDelay": 1 } } } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
", "smithy.api#output": {} } }, "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, and some SDKs do this decoding \n automatically.
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\n 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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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
", "smithy.api#output": {} } }, "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 IAM roles in the\n IAM User Guide.
\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, and some SDKs do this decoding \n automatically.
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, and some SDKs do this decoding \n automatically.
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 the\n 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.
\nFor more information about roles, see IAM roles in the\n IAM User Guide.
" } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetRolePolicy request.
", "smithy.api#output": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
", "smithy.api#output": {} } }, "com.amazonaws.iam#GetRoleTemplateVersion": { "type": "operation", "input": { "target": "com.amazonaws.iam#GetRoleTemplateVersionRequest" }, "output": { "target": "com.amazonaws.iam#GetRoleTemplateVersionResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a version of the specified role template. Role templates\n define a reusable configuration\u2014including role name and path patterns, trust\n policy, inline and managed policies, permissions boundary, tags, and maximum session\n duration\u2014that you use to create IAM roles with AcquireRole.
\nIf you do not specify a minor version, the service returns the template's default\n minor version.
" } }, "com.amazonaws.iam#GetRoleTemplateVersionRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role template whose version you want to\n retrieve.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "MinorVersion": { "target": "com.amazonaws.iam#minorVersionType", "traits": { "smithy.api#documentation": "The minor version of the role template to retrieve. If you do not specify a minor\n version, the service returns the template's default minor version.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetRoleTemplateVersionResponse": { "type": "structure", "members": { "RoleTemplateVersion": { "target": "com.amazonaws.iam#RoleTemplateVersion", "traits": { "smithy.api#documentation": "A structure that contains details about the requested role template version.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#GetSAMLProviderResponse": { "type": "structure", "members": { "SAMLProviderUUID": { "target": "com.amazonaws.iam#privateKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier assigned to the SAML provider.
" } }, "SAMLMetadataDocument": { "target": "com.amazonaws.iam#SAMLMetadataDocumentType", "traits": { "smithy.api#documentation": "The XML metadata document that includes information about an identity provider.
" } }, "ContextProvider": { "target": "com.amazonaws.iam#ContextProvider", "traits": { "smithy.api#documentation": "The trusted identity propagation context provider configuration associated with the SAML\n provider. For more information, see ContextProvider.
\nThis element is returned only when a trusted identity propagation context provider is configured for the SAML provider.
" } }, "SAMLKeyHashes": { "target": "com.amazonaws.iam#SAMLKeyHashListType", "traits": { "smithy.api#documentation": "The key hashes associated with the SAML provider, grouped by identity provider issuer.\n For more information, see SAMLKeyHashEntry.
" } }, "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.
" } }, "AssertionEncryptionMode": { "target": "com.amazonaws.iam#assertionEncryptionModeType", "traits": { "smithy.api#documentation": "Specifies the encryption setting for the SAML provider.
" } }, "PrivateKeyList": { "target": "com.amazonaws.iam#privateKeyList", "traits": { "smithy.api#documentation": "The private key metadata for the SAML provider.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.iam#identityCenterInstanceArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance associated with\n the SAML provider.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
\nThis element is returned only when an IAM Identity Center instance is associated with the SAML provider.
" } }, "IdentityStoreArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity store that is resolved from the\n associated IAM Identity Center instance.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
\nThis element is returned only when an IAM Identity Center instance is associated with the SAML provider.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetSAMLProvider request.\n
", "smithy.api#output": {} } }, "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 CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH\n connections in the 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.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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, Organizations policies, IAM permissions\n boundaries, and STS assume role policies. It only applies permissions policy\n 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 \u2013 Returns the user ARN that you\n used to generate the report
\n\n Group \u2013 Returns the ARN of the group\n member (user) that last attempted to access the service
\n\n Role \u2013 Returns the role ARN that you\n used to generate the report
\n\n Policy \u2013 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.
", "smithy.api#examples": [ { "title": "To get details from a previously-generated report", "documentation": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7", "input": { "JobId": "examplef-1305-c245-eba4-71fe298bcda7" }, "output": { "JobStatus": "COMPLETED", "JobCreationDate": "2018-10-24T19:47:31.466Z", "ServicesLastAccessed": [ { "TotalAuthenticatedEntities": 2, "LastAuthenticated": "2018-10-24T19:11:00Z", "ServiceNamespace": "iam", "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/AWSExampleUser01", "ServiceName": "AWS Identity and Access Management" }, { "TotalAuthenticatedEntities": 0, "ServiceNamespace": "s3", "ServiceName": "Amazon Simple Storage Service" } ], "JobCompletionDate": "2018-10-24T19:47:35.241Z", "IsTruncated": false } } ] } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 \u2013 For a group report, this\n operation returns a list of users in the group that could have used the group\u2019s\n policies in an attempt to access the service.
\n\n Policy \u2013 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.
", "smithy.api#examples": [ { "title": "To get sntity details from a previously-generated report", "documentation": "The following operation returns details about the entities that attempted to access the IAM service.", "input": { "JobId": "examplef-1305-c245-eba4-71fe298bcda7", "ServiceNamespace": "iam" }, "output": { "JobStatus": "COMPLETED", "JobCreationDate": "2018-10-24T19:47:31.466Z", "JobCompletionDate": "2018-10-24T19:47:35.241Z", "EntityDetailsList": [ { "EntityInfo": { "Id": "AIDAEX2EXAMPLEB6IGCDC", "Name": "AWSExampleUser01", "Type": "USER", "Path": "/", "Arn": "arn:aws:iam::123456789012:user/AWSExampleUser01" }, "LastAuthenticated": "2018-10-24T19:10:00Z" }, { "EntityInfo": { "Id": "AROAEAEXAMPLEIANXSIU4", "Name": "AWSExampleRole01", "Type": "ROLE", "Path": "/", "Arn": "arn:aws:iam::123456789012:role/AWSExampleRole01" } } ], "IsTruncated": false } } ] } }, "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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services\n service namespaces in the Amazon Web Services 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 Amazon Web Services 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.
" } } }, "traits": { "smithy.api#output": {} } }, "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, you\n 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/<service-principal-name>/<role-name>/<task-uuid>.
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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Web Services access key ID used to sign the request to this operation.
", "smithy.api#examples": [ { "title": "To get information about an IAM user", "documentation": "The following command gets information about the IAM user named Bob.", "input": { "UserName": "Bob" }, "output": { "User": { "UserName": "Bob", "Path": "/", "CreateDate": "2012-09-21T23:03:13Z", "UserId": "AKIAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } } } ], "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], "smithy.test#smokeTests": [ { "id": "GetUserFailure", "params": { "UserName": "fake_user" }, "vendorParams": { "region": "us-east-1" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "failure": {} } } ], "smithy.waiters#waitable": { "UserExists": { "acceptors": [ { "state": "success", "matcher": { "success": true } }, { "state": "retry", "matcher": { "errorType": "NoSuchEntity" } } ], "minDelay": 1 } } } }, "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, and some SDKs do this decoding \n automatically.
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 the\n 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#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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 CloudFormation\n templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format\n before submitting it to IAM.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful GetUserPolicy request.
", "smithy.api#output": {} } }, "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: _+=,.@-
" } } }, "traits": { "smithy.api#input": {} } }, "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 Amazon Web Services in the\n last 90 days. In cases like this, we recommend that you adjust your evaluation\n window to include dates after May 23, 2018. Alternatively, if your users use access\n keys to access Amazon Web Services programmatically you can refer to access key last used\n information because it is accurate for all dates.
\nContains the response to a successful GetUser request.
", "smithy.api#output": {} } }, "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#InlinePolicy": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the inline policy.
", "smithy.api#required": {} } }, "PolicyDocument": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The inline policy document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains an inline policy template that the service embeds in roles that you create from a\n role template.
" } }, "com.amazonaws.iam#InlinePolicyIdentifierType": { "type": "structure", "members": { "PolicyName": { "target": "com.amazonaws.iam#policyNameType", "traits": { "smithy.api#documentation": "The name of the inline policy.
", "smithy.api#required": {} } }, "AttachmentType": { "target": "com.amazonaws.iam#AttachmentType", "traits": { "smithy.api#documentation": "The type of IAM entity that the inline policy is attached to.
", "smithy.api#required": {} } }, "AttachmentName": { "target": "com.amazonaws.iam#AttachmentName", "traits": { "smithy.api#documentation": "The name of the IAM user, group, or role that the inline policy is attached to.\n Wildcard characters are supported to match multiple entities: use at most one\n * (matches any sequence of characters, including none), and any number of\n ? (each matches exactly one character).
Identifies one or more inline policies that are embedded in IAM users, groups, or\n roles, by the name of the policy together with the type and name of the entity that it is\n attached to. Wildcard characters in the entity name can match multiple entities, so a\n single identifier can select more than one attached inline policy.
" } }, "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": { "aws.protocols#awsQueryError": { "code": "InvalidCertificate", "httpResponseCode": 400 }, "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": { "aws.protocols#awsQueryError": { "code": "InvalidInput", "httpResponseCode": 400 }, "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": { "aws.protocols#awsQueryError": { "code": "InvalidPublicKey", "httpResponseCode": 400 }, "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": { "aws.protocols#awsQueryError": { "code": "InvalidUserType", "httpResponseCode": 400 }, "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#KeyHashListType": { "type": "list", "member": { "target": "com.amazonaws.iam#stringType" }, "traits": { "smithy.api#documentation": "Contains a list of key hashes for a SAML identity provider issuer.
" } }, "com.amazonaws.iam#KeyPairMismatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#keyPairMismatchMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KeyPairMismatch", "httpResponseCode": 400 }, "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": { "aws.protocols#awsQueryError": { "code": "LimitExceeded", "httpResponseCode": 409 }, "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current\n Amazon Web Services account limits. The error message describes the limit exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#LineNumber": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "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 is not specified, the user name is determined implicitly\n based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has\n no associated users, the root user returns it's own access key IDs by running this\n command.
\nTo ensure the security of your Amazon Web Services 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#default": false, "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
", "smithy.api#output": {} } }, "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 Amazon Web Services account (Note: you can have only\n one). For information about using an Amazon Web Services account alias, see Creating,\n deleting, and listing an Amazon Web Services account alias in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To list account aliases", "documentation": "The following command lists the aliases for the current account.", "output": { "AccountAliases": [ "exmaple-corporation" ] } } ], "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. Amazon Web Services supports only one alias per\n account.
", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "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\n request.
", "smithy.api#output": {} } }, "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.\n For 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. 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#default": false, "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 request.
", "smithy.api#output": {} } }, "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.\n For 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. 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#default": false, "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 request.
", "smithy.api#output": {} } }, "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.\n For 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. 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#default": false, "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 request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#ListDelegationRequests": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListDelegationRequestsRequest" }, "output": { "target": "com.amazonaws.iam#ListDelegationRequestsResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" } ], "traits": { "smithy.api#documentation": "Lists delegation requests based on the specified criteria.
\nIf a delegation request has no owner, even if it is assigned to a specific account, it will not be part of the\n ListDelegationRequests output for that account.
\n For more details, see\n \n Managing Permissions for Delegation Requests.\n
" } }, "com.amazonaws.iam#ListDelegationRequestsRequest": { "type": "structure", "members": { "OwnerId": { "target": "com.amazonaws.iam#ownerIdType", "traits": { "smithy.api#documentation": "The owner ID to filter delegation requests by.
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after you receive a response\n indicating that the results are truncated. Set it to the value of the\n Marker\n element in the response that you received to indicate where the next\n call should start.\n
Use this only when paginating results to indicate the maximum number of items you\n want in the response. If additional items exist beyond the maximum you specify, the\n IsTruncated\n response element is true.\n
If you do not include this parameter, the number of items defaults to 100. Note that\n IAM may return fewer results, even when there are more results available. In that case,\n the IsTruncated response element returns true, and\n Marker\n contains a value to include in the subsequent call that tells the\n service where to continue from.\n
A list of delegation requests that match the specified criteria.
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "When isTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
A flag that indicates whether there are more items to return.\n If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items.
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 Amazon Web Services 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#default": false, "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\n request.
", "smithy.api#output": {} } }, "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. For more information about policies, see Managed\n policies and inline policies in the\n 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#default": false, "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
", "smithy.api#output": {} } }, "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#default": false, "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
", "smithy.api#output": {} } }, "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#default": false, "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.
", "smithy.api#output": {} } }, "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.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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 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.
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#default": false, "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.
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 Using\n instance profiles 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 an instance profile, see\n 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 Using\n instance profiles in the IAM User Guide.
\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#default": false, "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 request.
", "smithy.api#output": {} } }, "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#default": false, "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\n request.
", "smithy.api#output": {} } }, "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.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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 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.
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#default": false, "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.
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 Amazon Web Services\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#default": false, "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
", "smithy.api#output": {} } }, "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.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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 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.
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#default": false, "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.
Lists information about the IAM OpenID Connect (OIDC) provider resource objects\n defined in the Amazon Web Services 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 Amazon Web Services account.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful ListOpenIDConnectProviders request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#ListOrganizationsFeatures": { "type": "operation", "input": { "target": "com.amazonaws.iam#ListOrganizationsFeaturesRequest" }, "output": { "target": "com.amazonaws.iam#ListOrganizationsFeaturesResponse" }, "errors": [ { "target": "com.amazonaws.iam#AccountNotManagementOrDelegatedAdministratorException" }, { "target": "com.amazonaws.iam#OrganizationNotFoundException" }, { "target": "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException" }, { "target": "com.amazonaws.iam#ServiceAccessNotEnabledException" } ], "traits": { "smithy.api#documentation": "Lists the centralized root access features enabled for your organization. For more\n information, see Centrally manage root access for member accounts.
", "smithy.api#examples": [ { "title": "To list the centralized root access features enabled for your organization", "documentation": "he following command lists the centralized root access features enabled for your organization.", "output": { "OrganizationId": "o-aa111bb222", "EnabledFeatures": [ "RootCredentialsManagement" ] } } ] } }, "com.amazonaws.iam#ListOrganizationsFeaturesRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#ListOrganizationsFeaturesResponse": { "type": "structure", "members": { "OrganizationId": { "target": "com.amazonaws.iam#OrganizationIdType", "traits": { "smithy.api#documentation": "The unique identifier (ID) of an organization.
" } }, "EnabledFeatures": { "target": "com.amazonaws.iam#FeaturesListType", "traits": { "smithy.api#documentation": "Specifies the features that are currently available in your organization.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Web Services account, including\n your own customer-defined managed policies and all Amazon Web Services 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 Amazon Web Services\n account, set Scope to Local. To list only Amazon Web Services 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, Organizations policies, IAM permissions boundaries, and STS\n assume role policies. It only applies permissions policy logic. For more about the\n 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 \u2013 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 \u2013 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\u2019s user are not included.
\n\n Role \u2013 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.
", "smithy.api#examples": [ { "title": "To list policies that allow access to a service", "documentation": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.", "input": { "Arn": "arn:aws:iam::123456789012:user/ExampleUser01", "ServiceNamespaces": [ "iam", "ec2" ] }, "output": { "IsTruncated": false, "PoliciesGrantingServiceAccess": [ { "Policies": [ { "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleIamPolicy", "PolicyType": "MANAGED", "PolicyName": "ExampleIamPolicy" }, { "EntityName": "AWSExampleGroup1", "EntityType": "GROUP", "PolicyType": "INLINE", "PolicyName": "ExampleGroup1Policy" } ], "ServiceNamespace": "iam" }, { "Policies": [ { "PolicyArn": "arn:aws:iam::123456789012:policy/ExampleEc2Policy", "PolicyType": "MANAGED", "PolicyName": "ExampleEc2Policy" } ], "ServiceNamespace": "ec2" } ] } } ] } }, "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 Amazon Web Services 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 Amazon Web Services\n service namespaces in the\u00a0Amazon Web Services General Reference.
The\u00a0PoliciesGrantingServiceAccess 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 Amazon Web Services services whose policies you want to list.
\nTo learn the service namespace for a service, see Actions, resources, and condition keys for Amazon Web Services 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 Amazon Web Services\n service namespaces in the Amazon Web Services 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 Amazon Web Services managed policies, set Scope to AWS. To\n list only the customer managed policies in your Amazon Web Services 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#default": false, "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.
", "smithy.api#output": {} } }, "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.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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 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.
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#default": false, "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.
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 Amazon Web Services 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#default": false, "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\n request.
", "smithy.api#output": {} } }, "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. For more information about policies, see Managed\n policies and inline policies in the\n 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#default": false, "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
", "smithy.api#output": {} } }, "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.
", "smithy.api#examples": [ { "title": "To list the tags attached to an IAM role", "documentation": "The following example shows how to list the tags attached to a role.", "input": { "RoleName": "taggedrole1" }, "output": { "Tags": [ { "Key": "Dept", "Value": "12345" }, { "Key": "Team", "Value": "Accounting" } ], "IsTruncated": false } } ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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.
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 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#default": false, "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.
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 IAM roles in the\n IAM User Guide.
\nIAM resource-listing operations return a subset of the available \n attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
\nPermissionsBoundary
\nRoleLastUsed
\nTags
\nTo 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#default": false, "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.
", "smithy.api#output": {} } }, "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.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "items": "Tags", "pageSize": "MaxItems" } } }, "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 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.
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#default": false, "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.
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 Amazon Web Services\n account.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful ListSAMLProviders request.\n
", "smithy.api#output": {} } }, "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 CodeCommit repository. For more information about using SSH keys to\n authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the 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 Amazon Web Services 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#default": false, "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.
", "smithy.api#output": {} } }, "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 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 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.
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#default": false, "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.
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 Amazon Web Services 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\n 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#default": false, "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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services service, refer to the following docs:
\nFor service-specific credentials with CodeCommit, refer to IAM credentials for CodeCommit: Git credentials, SSH keys, and Amazon Web Services access\n keys in the IAM User Guide.
\nFor service-specific credentials with Amazon Keyspaces (for Apache Cassandra), refer to Use IAM with\n Amazon Keyspaces (for Apache Cassandra) in the\n IAM User Guide.
\nFor services that support long-term API keys, refer to API\n keys for Amazon Web Services services in the\n IAM User Guide.
\nThe 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 Amazon Web Services service. If not\n specified, then Amazon Web Services returns service-specific credentials for all services.
" } }, "AllUsers": { "target": "com.amazonaws.iam#allUsers", "traits": { "smithy.api#documentation": "A flag indicating whether to list service specific credentials for all users. This\n parameter cannot be specified together with UserName. When true, returns all credentials\n associated with the specified service.
" } }, "Marker": { "target": "com.amazonaws.iam#markerType", "traits": { "smithy.api#documentation": "Use this parameter only when paginating results and only after you receive a response\n indicating that the results are truncated. Set it to the value of the Marker from the\n response that you received to indicate where the next call should start.
" } }, "MaxItems": { "target": "com.amazonaws.iam#maxItemsType", "traits": { "smithy.api#documentation": "Use this only when paginating results to indicate the maximum number of items you want\n in the response. If additional items exist beyond the maximum you specify, the\n IsTruncated response element is true.
" } } }, "traits": { "smithy.api#input": {} } }, "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.
" } }, "Marker": { "target": "com.amazonaws.iam#responseMarkerType", "traits": { "smithy.api#documentation": "When IsTruncated is true, this element is present and contains the value to use for\n the Marker parameter in a subsequent pagination request.
" } }, "IsTruncated": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "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 request\n parameter to retrieve more items.
" } } }, "traits": { "smithy.api#output": {} } }, "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 Amazon Web Services access key ID used to sign the request for this operation.\n This operation works for access keys under the Amazon Web Services account. Consequently, you can use\n this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no\n 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#default": false, "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 request.
", "smithy.api#output": {} } }, "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. For more information about policies, see Managed\n policies and inline policies in the\n 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#default": false, "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
", "smithy.api#output": {} } }, "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#examples": [ { "title": "To list the tags attached to an IAM user", "documentation": "The following example shows how to list the tags attached to a user.", "input": { "UserName": "anika" }, "output": { "Tags": [ { "Key": "Dept", "Value": "12345" }, { "Key": "Team", "Value": "Accounting" } ], "IsTruncated": false } } ], "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 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.
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#default": false, "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.
Lists the IAM users that have the specified path prefix. If no path prefix is\n specified, the operation returns all users in the Amazon Web Services 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. This operation does not return the following attributes, even though they are an attribute of the returned object:
\nPermissionsBoundary
\nTags
\nTo 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#default": false, "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.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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 tag information for a virtual MFA device, see ListMFADeviceTags.
\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\n request.
", "smithy.api#output": {} } }, "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 Amazon Web Services Management 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#default": false, "smithy.api#documentation": "Specifies whether the user is required to set a new password on next sign-in.
" } }, "MaxSigninSessionDuration": { "target": "com.amazonaws.iam#maxSigninSessionDurationType", "traits": { "smithy.api#documentation": "The maximum duration (in seconds) of an Amazon Web Services Sign-In session for the user.
\nThis member is omitted when the setting is unset. In that case, no default value is\n returned and the existing sign-in session behavior applies.
" } } }, "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\n 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": { "aws.protocols#awsQueryError": { "code": "MalformedCertificate", "httpResponseCode": 400 }, "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": { "aws.protocols#awsQueryError": { "code": "MalformedPolicyDocument", "httpResponseCode": 400 }, "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#default": false, "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#NameConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#nameConflictMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NameConflict", "httpResponseCode": 409 }, "smithy.api#documentation": "The request was rejected because the resulting role name conflicts with an existing role\n in the account.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#NoSuchEntityException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#noSuchEntityMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "NoSuchEntity", "httpResponseCode": 404 }, "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" }, "IsTrustedIdentityPropagationEnabled": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether trusted identity propagation is enabled for the OpenID Connect (OIDC)\n provider. This is true when an IAM Identity Center instance is associated\n with the provider.
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#OpenIdIdpCommunicationErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#openIdIdpCommunicationErrorExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "OpenIdIdpCommunicationError", "httpResponseCode": 400 }, "smithy.api#documentation": "The request failed because IAM cannot connect to the OpenID Connect identity provider\n URL.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#OrderedOrganizationPolicyType": { "type": "structure", "members": { "ServiceControlPolicyInputList": { "target": "com.amazonaws.iam#SimulationPolicyListType", "traits": { "smithy.api#documentation": "A list of SCP documents that apply at this level of the Organizations hierarchy. Each document\n is specified as a string containing the complete, valid JSON text of an SCP.
" } } }, "traits": { "smithy.api#documentation": "Represents one level of an Organizations hierarchy\u2014the organization root, an organizational\n unit (OU), or an account\u2014together with the service control policies (SCPs) that apply at\n that level. Each element in the list represents one level of the hierarchy, ordered from\n the organization root down to the account.
\nFor more information about SCPs, see Service control\n policies (SCPs) in the Organizations User Guide.
" } }, "com.amazonaws.iam#OrganizationIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 34 }, "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" } }, "com.amazonaws.iam#OrganizationNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because no organization is associated with your account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#OrganizationNotInAllFeaturesModeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because your organization does not have All features enabled. For\n more information, see Available feature sets in the Organizations User\n Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#OrganizationPolicyListType": { "type": "list", "member": { "target": "com.amazonaws.iam#OrderedOrganizationPolicyType" }, "traits": { "smithy.api#length": { "min": 0, "max": 7 } } }, "com.amazonaws.iam#OrganizationsDecisionDetail": { "type": "structure", "members": { "AllowedByOrganizations": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "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#ParameterDefinition": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.iam#parameterNameType", "traits": { "smithy.api#documentation": "The name of the parameter.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.iam#parameterTypeType", "traits": { "smithy.api#documentation": "The data type of the parameter. Valid values are String,\n StringList, Number, NumberList,\n Arn, and ArnList.
An optional subtype that further constrains the values that are allowed for the\n parameter.
" } }, "Description": { "target": "com.amazonaws.iam#parameterDescriptionType", "traits": { "smithy.api#documentation": "A description of the parameter.
" } }, "IsRequired": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether you must supply a value for the parameter when you create a role from\n the template.
" } }, "DefaultValue": { "target": "com.amazonaws.iam#parameterDefaultValueType", "traits": { "smithy.api#documentation": "The value that the service uses for the parameter when you do not supply one.
" } }, "Immutable": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether you can change the parameter value after you create the role.
" } } }, "traits": { "smithy.api#documentation": "Defines a parameter that a role template accepts. You supply values for these parameters\n when you create a role with AcquireRole.
" } }, "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#default": false, "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one of the following\n symbols:
\n! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
" } }, "RequireNumbers": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one numeric character (0 to\n 9).
" } }, "RequireUppercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one uppercase character (A\n to Z).
" } }, "RequireLowercaseCharacters": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether IAM user passwords must contain at least one lowercase character (a\n to z).
" } }, "AllowUsersToChangePassword": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether IAM users are allowed to change their own password. Gives IAM\n users permissions to iam:ChangePassword for only their user and to the\n iam:GetAccountPasswordPolicy action. This option does not attach a\n permissions policy to each user, rather the permissions are applied at the account-level\n for all users by IAM.
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 via the\n Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until\n an administrator resets the password. IAM users with iam:ChangePassword\n permission and active access keys can reset their own expired console password using the\n CLI or API.
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": { "aws.protocols#awsQueryError": { "code": "PasswordPolicyViolation", "httpResponseCode": 400 }, "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": "enum", "members": { "Policy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PermissionsBoundaryPolicy" } } } }, "com.amazonaws.iam#PermissionsBoundaryDecisionDetail": { "type": "structure", "members": { "AllowedByPermissionsBoundary": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "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#default": false, "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. It is not\n included in the response to the ListPolicies operation.\n
" } }, "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, GetPolicy,\n 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": "enum", "members": { "ALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "allowed" } }, "EXPLICIT_DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "explicitDeny" } }, "IMPLICIT_DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "implicitDeny" } } } }, "com.amazonaws.iam#PolicyEvaluationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#policyEvaluationErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "PolicyEvaluation", "httpResponseCode": 500 }, "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#PolicyExclusionsListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyIdentifier" }, "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "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#PolicyIdentifier": { "type": "union", "members": { "PolicyType": { "target": "com.amazonaws.iam#PolicyIdentifierPolicyType", "traits": { "smithy.api#documentation": "The policy type to identify. All policies of the specified type are matched.
" } }, "PolicyArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services managed policy or a customer managed policy\n that is attached to an IAM user, group, or role. Wildcard characters are supported in\n the resource name portion of the ARN to match multiple managed policies: use at most one\n * (matches any sequence of characters, including none), and any number of\n ? (each matches exactly one character).
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "InlinePolicyIdentifier": { "target": "com.amazonaws.iam#InlinePolicyIdentifierType", "traits": { "smithy.api#documentation": "An inline policy identifier consisting of a policy name and the entity it is attached\n to. Wildcard characters (* and ?) in the entity name can match\n multiple entities.
Identifies one or more policies as a union type. Specify exactly one of\n PolicyType, PolicyArn, or\n InlinePolicyIdentifier to identify policies by their type, by Amazon\n Resource Name (ARN), or by the name of an inline policy and the entity it is attached\n to.
The request failed because Amazon Web Services 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#PolicyParameter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.iam#policyParameterNameType", "traits": { "smithy.api#documentation": "The name of the policy parameter.
" } }, "Values": { "target": "com.amazonaws.iam#policyParameterValuesListType", "traits": { "smithy.api#documentation": "The allowed values for the policy parameter.
" } }, "Type": { "target": "com.amazonaws.iam#PolicyParameterTypeEnum", "traits": { "smithy.api#documentation": "The data type of the policy parameter value.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a policy parameter used to customize delegated permissions.
" } }, "com.amazonaws.iam#PolicyParameterTypeEnum": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "string" } }, "STRING_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stringList" } } } }, "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": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user" } }, "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "group" } }, "ROLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "role" } }, "AWS_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws-managed" } }, "USER_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user-managed" } }, "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "resource" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } } } }, "com.amazonaws.iam#PolicyUsageType": { "type": "enum", "members": { "PermissionsPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PermissionsPolicy" } }, "PermissionsBoundary": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PermissionsBoundary" } } }, "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.
" } }, "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\n GetAccountAuthorizationDetails operations. It is not returned in the response\n to the CreatePolicyVersion\n 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,\n GetPolicyVersion, ListPolicyVersions,\n 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#default": 0, "smithy.api#documentation": "The line containing the specified position in the document.
" } }, "Column": { "target": "com.amazonaws.iam#ColumnNumber", "traits": { "smithy.api#default": 0, "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.
Sets account-level properties for the caller's Amazon Web Services account. Account properties are\n configuration settings that control account-wide IAM features such as Role\n Manager.
\nSpecify properties as key-value pairs in\n Namespace/PropertyName format. All properties in a single request must\n belong to the same namespace. Use GetAccountProperties to view the current properties.
A map of property key-value pairs to set. All keys must belong to the same\n namespace.
\nEach key uses the format Namespace/PropertyName. The key must contain\n exactly one / separating the namespace from the property name, and cannot\n start or end with /.
The service validates each value based on the property key's expected type. For\n example, boolean properties expect true or false.
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 \n AttachGroupPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
For 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 CloudFormation templates\n formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always\n converts a YAML policy to JSON format before 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)
Adds or updates the policy that is specified as the IAM role's permissions boundary.\n You can use an Amazon Web Services 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 managed policy that is used to set the permissions boundary for the\n role.
\nA permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.
\nFor more information about policy types, see Policy types\n in the IAM User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#PutRolePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#PutRolePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 \n CreateRole\n .\n You can update a role's trust policy using \n UpdateAssumeRolePolicy\n . For more information about roles,\n see IAM\n roles in the IAM User Guide.
A role can also have a managed policy attached to it. To attach a managed policy to a\n role, use \n AttachRolePolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
For 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 CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\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\n boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the\n boundary for a user. Use the boundary to control the maximum permissions that the user\n can have. Setting a permissions boundary is an advanced feature that can affect the\n permissions 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 managed policy that is used to set the permissions boundary for the\n user.
\nA permissions boundary policy defines the maximum permissions that identity-based\n policies can grant to an entity, but does not grant permissions. Permissions boundaries\n do not define the maximum permissions that a resource-based policy can grant to an\n entity. To learn more, see Permissions boundaries\n for IAM entities in the IAM User Guide.
\nFor more information about policy types, see Policy types\n in the IAM User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#PutUserPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#PutUserPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 \n AttachUserPolicy\n . To create a new managed policy, use\n \n CreatePolicy\n . For information about policies, see Managed\n policies and inline policies in the\n IAM User Guide.
For 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 CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\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)
Rejects a delegation request, denying the requested temporary access.
\nOnce a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days.
\nWhen rejecting a request, an optional explanation can be added using the Notes request parameter.
\n For more details, see\n \n Managing Permissions for Delegation Requests.\n
" } }, "com.amazonaws.iam#RejectDelegationRequestRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier of the delegation request to reject.
", "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.iam#notesType", "traits": { "smithy.api#documentation": "Optional notes explaining the reason for rejecting the delegation request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#RemoveRoleFromInstanceProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon EC2 instance profile.
\nMake sure that you do not have any Amazon EC2 instances running with the role you are\n about to remove from the instance profile. Removing a role from an instance profile\n that is associated with a running instance might break any applications running on\n the instance.
\nFor more information about roles, see IAM roles in the\n IAM User Guide. For more information about instance profiles,\n see Using\n instance profiles in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To remove a role from an instance profile", "documentation": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", "input": { "RoleName": "Test-Role", "InstanceProfileName": "ExampleInstanceProfile" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#RemoveUserFromGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#RemoveUserFromGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
", "smithy.api#examples": [ { "title": "To remove a user from an IAM group", "documentation": "The following command removes the user named Bob from the IAM group named Admins.", "input": { "UserName": "Bob", "GroupName": "Admins" } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#ReplacementValueEntry": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.iam#replacementValueListType", "traits": { "smithy.api#documentation": "The list of replacement values for the template parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the list of replacement values for a single template parameter used when\n creating a role from a role template.
" } }, "com.amazonaws.iam#ReportContentType": { "type": "blob" }, "com.amazonaws.iam#ReportFormatType": { "type": "enum", "members": { "text_csv": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "text/csv" } } } }, "com.amazonaws.iam#ReportGenerationLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#reportGenerationLimitExceededMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReportGenerationLimitExceeded", "httpResponseCode": 409 }, "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": "enum", "members": { "STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } }, "INPROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INPROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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 Amazon Web Services\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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 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" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "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 Amazon Web Services\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": {} } } }, "traits": { "smithy.api#input": {} } }, "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 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 maximum duration (in seconds) of an Amazon Web Services Sign-In session for users who sign in\n with this role. This value is independent of MaxSessionDuration.
This member is omitted when the setting is unset. In that case, no default value is\n returned and the existing sign-in session behavior applies.
" } }, "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.
" } }, "SourceRoleTemplate": { "target": "com.amazonaws.iam#SourceRoleTemplate", "traits": { "smithy.api#documentation": "Contains information about the role template that this role was created from. This\n member is present only for roles created with AcquireRole.
" } } }, "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\n IAM User 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\u00a0ISO 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.\n
" } }, "Region": { "target": "com.amazonaws.iam#stringType", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services 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 GetAccountAuthorizationDetails operations.
" } }, "com.amazonaws.iam#RoleModifiedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#roleModifiedMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RoleModified", "httpResponseCode": 409 }, "smithy.api#documentation": "The request was rejected because someone modified the role template while the service was\n creating the role. Wait a few minutes and try the request again.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iam#RoleTemplateDisabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#roleTemplateDisabledMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "RoleTemplateDisabled", "httpResponseCode": 400 }, "smithy.api#documentation": "The request was rejected because the specified role template is disabled. A disabled\n role template cannot be used to create new roles. Contact your administrator to enable the\n role template, or use a different role template.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#RoleTemplateVersion": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the role template.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "TemplateName": { "target": "com.amazonaws.iam#roleTemplateNameType", "traits": { "smithy.api#documentation": "The friendly name that identifies the role template.
" } }, "TemplateVersionId": { "target": "com.amazonaws.iam#idType", "traits": { "smithy.api#documentation": "The identifier of the role template version.
" } }, "Description": { "target": "com.amazonaws.iam#roleTemplateDescriptionType", "traits": { "smithy.api#documentation": "The description of the role template.
" } }, "MajorVersion": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The major version number of the role template.
" } }, "DefaultMinorVersion": { "target": "com.amazonaws.iam#minorVersionType", "traits": { "smithy.api#documentation": "The minor version that the service uses by default when you create a role from this template\n without specifying a minor version.
" } }, "ManagedByType": { "target": "com.amazonaws.iam#managedByTypeType", "traits": { "smithy.api#documentation": "Indicates that the role template is managed by an Amazon Web Services service.
" } }, "ManagedByValue": { "target": "com.amazonaws.iam#managedByValueType", "traits": { "smithy.api#documentation": "The identifier of the Amazon Web Services service that manages the role template.
" } }, "Enabled": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether the role template is enabled. When a template is disabled, you cannot\n create roles from it.
" } }, "MinorVersion": { "target": "com.amazonaws.iam#minorVersionType", "traits": { "smithy.api#documentation": "The minor version number of this role template version.
" } }, "RoleNamePattern": { "target": "com.amazonaws.iam#roleNamePatternType", "traits": { "smithy.api#documentation": "The pattern that is used to generate the name of a role that is created from this\n template. The pattern can include @{parameter} placeholders that are replaced\n with the values you supply in the ReplacementValues parameter of AcquireRole.
The pattern that is used to generate the path of a role that is created from this\n template.
" } }, "RoleDescriptionPattern": { "target": "com.amazonaws.iam#roleDescriptionPatternType", "traits": { "smithy.api#documentation": "The pattern that is used to generate the description of a role that is created from this\n template.
" } }, "AssumeRolePolicyDocumentTemplate": { "target": "com.amazonaws.iam#policyDocumentType", "traits": { "smithy.api#documentation": "The trust policy template that grants an entity permission to assume roles that you\n create from this template.
" } }, "InlinePolicyTemplates": { "target": "com.amazonaws.iam#inlinePolicyTemplateListType", "traits": { "smithy.api#documentation": "A list of inline policy templates that the service embeds in roles that you create from\n this template.
" } }, "ManagedPolicyArns": { "target": "com.amazonaws.iam#managedPolicyArnListType", "traits": { "smithy.api#documentation": "A list of the ARNs of the managed policies that the service attaches to roles that you\n create from this template.
" } }, "PermissionBoundaryArn": { "target": "com.amazonaws.iam#arnType", "traits": { "smithy.api#documentation": "The ARN of the policy that sets the permissions boundary for roles that you create from\n this template.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "ParametersDefinition": { "target": "com.amazonaws.iam#parametersDefinitionListType", "traits": { "smithy.api#documentation": "A list of the parameters that are defined for this role template version. You supply\n values for these parameters when you create a role with AcquireRole.
" } }, "RoleTagsTemplate": { "target": "com.amazonaws.iam#tagTemplateListType", "traits": { "smithy.api#documentation": "A list of tag templates that are applied to roles that are created from this\n template.
" } }, "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { "smithy.api#documentation": "The maximum session duration (in seconds) for roles that are created from this\n template.
" } }, "VersionEnabled": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether this specific minor version of the role template is enabled.
" } }, "CreateTimestamp": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the role template version was created.
" } }, "UpdateTimestamp": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the role template version was last updated.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a version of an IAM role template, including the\n configuration that is used to create roles with AcquireRole. This structure\n is returned as a response element by the GetRoleTemplateVersion operation.
" } }, "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#SAMLIssuerURLType": { "type": "string", "traits": { "smithy.api#documentation": "Contains the issuer URL for a SAML identity provider. The value can be from 1 to 1024\n characters in length.
", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.iam#SAMLKeyHashEntry": { "type": "structure", "members": { "IssuerURL": { "target": "com.amazonaws.iam#SAMLIssuerURLType", "traits": { "smithy.api#documentation": "The issuer URL of the SAML identity provider that the key hashes are associated\n with.
" } }, "KeyHashes": { "target": "com.amazonaws.iam#KeyHashListType", "traits": { "smithy.api#documentation": "The list of key hashes for the SAML identity provider issuer.
" } } }, "traits": { "smithy.api#documentation": "Contains the key hashes that are associated with a SAML identity provider issuer.
\nThis data type is used as a response element in the GetSAMLProvider\n operation.
" } }, "com.amazonaws.iam#SAMLKeyHashListType": { "type": "list", "member": { "target": "com.amazonaws.iam#SAMLKeyHashEntry" }, "traits": { "smithy.api#documentation": "Contains a list of SAMLKeyHashEntry values,\n each of which pairs a SAML identity provider issuer with its key hashes.
" } }, "com.amazonaws.iam#SAMLMetadataDocumentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1000, "max": 10000000 } } }, "com.amazonaws.iam#SAMLPrivateKey": { "type": "structure", "members": { "KeyId": { "target": "com.amazonaws.iam#privateKeyIdType", "traits": { "smithy.api#documentation": "The unique identifier for the SAML private key.
" } }, "Timestamp": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time, in ISO 8601 date-time\n format, when the private key was uploaded.
" } } }, "traits": { "smithy.api#documentation": "Contains the private keys for the SAML provider.
\nThis data type is used as a response element in the GetSAMLProvider\n operation.
" } }, "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.
" } }, "IsTrustedIdentityPropagationEnabled": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether trusted identity propagation is enabled for the SAML provider. This is\n true when an IAM Identity Center instance is associated with the\n provider.
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 CodeCommit repository. Inactive means that the key cannot be\n 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 and\n 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 CodeCommit repository. Inactive means that the key cannot be\n 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#SendDelegationToken": { "type": "operation", "input": { "target": "com.amazonaws.iam#SendDelegationTokenRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "Sends the exchange token for an accepted delegation request.
\nThe exchange token is sent to the partner via an asynchronous notification channel, established by the partner.
\nThe delegation request must be in the ACCEPTED state when calling this API. After the\n SendDelegationToken API\n call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject\n an accepted request before the SendDelegationToken API is called.
\n For more details, see\n \n Managing Permissions for Delegation Requests.\n
" } }, "com.amazonaws.iam#SendDelegationTokenRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier of the delegation request for which to send the token.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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\n 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 operations.
" } }, "com.amazonaws.iam#ServiceAccessNotEnabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.iam#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#ServiceFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#serviceFailureExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ServiceFailure", "httpResponseCode": 500 }, "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\u00a0ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n service. Amazon Web Services does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking 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 Amazon Web Services 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 Amazon Web Services\n Service Namespaces in the\u00a0Amazon Web Services General Reference.
The ARN of the authenticated entity (user or role) that last attempted to access the\n service. Amazon Web Services does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking 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. Amazon Web Services does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking period.
" } }, "TotalAuthenticatedEntities": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The total number of authenticated principals (root user, IAM users, or IAM roles) that\n have attempted to access the service.
\nThis field is null if no principals attempted to access the service within the tracking 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 tracking 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": { "aws.protocols#awsQueryError": { "code": "NotSupportedService", "httpResponseCode": 404 }, "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": {} } }, "ExpirationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the service specific credential expires. This field is only\n present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.
" } }, "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#addedDefault": {}, "smithy.api#default": "", "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 Amazon Web Services 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.
" } }, "ServiceCredentialAlias": { "target": "com.amazonaws.iam#serviceCredentialAlias", "traits": { "smithy.api#documentation": "For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM\n user name and a suffix containing version and creation information.
" } }, "ServiceCredentialSecret": { "target": "com.amazonaws.iam#serviceCredentialSecret", "traits": { "smithy.api#documentation": "For Bedrock API keys and CloudWatch Logs API keys, this is the secret portion of the credential that should be used\n to authenticate API calls. This value is returned only when the credential is\n created.
" } }, "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.
" } }, "ServiceCredentialAlias": { "target": "com.amazonaws.iam#serviceCredentialAlias", "traits": { "smithy.api#documentation": "For Bedrock API keys and CloudWatch Logs API keys, this is the public portion of the credential that includes the IAM\n user name and a suffix containing version and creation information.
" } }, "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": {} } }, "ExpirationDate": { "target": "com.amazonaws.iam#dateType", "traits": { "smithy.api#documentation": "The date and time when the service specific credential expires. This field is only\n present for Bedrock API keys and CloudWatch Logs API keys that were created with an expiration period.
" } }, "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" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#SetSecurityTokenServicePreferences": { "type": "operation", "input": { "target": "com.amazonaws.iam#SetSecurityTokenServicePreferencesRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services account.
\nBy default, 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. Amazon Web Services 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 Security Token Service\n endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might\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 Amazon Web Services Regions that are\n available by default. These tokens do not work in manually enabled Regions, such as Asia\n Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2\n tokens are longer and might affect systems where you temporarily store tokens. For\n information, see Activating and\n deactivating STS in an Amazon Web Services 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 Amazon Web Services Regions that are available by default. These tokens do not work in\n manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid\n in all Regions. However, version 2 tokens are longer and might affect systems where you\n temporarily store tokens.
\nFor information, see Activating and\n deactivating STS in an Amazon Web Services Region in the\n IAM User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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 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 Amazon Web Services 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 Amazon Web Services 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.
The IAM policy simulator evaluates statements in identity-based policies,\n service control policies (SCPs) including their condition keys and resource\n scoping, and the inputs that you provide during simulation. The policy\n simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies\n against your live Amazon Web Services environment after testing using the policy simulator to\n confirm that you have the desired results. For more information about using the\n policy simulator, see Testing IAM\n policies with the IAM policy simulator in the\n IAM User Guide.
\nA 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 maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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 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 maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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 ordered list of service control policies (SCPs) to include in the simulation. Each\n element represents one level of an Organizations hierarchy, from the organization root to the\n account.
\nThe simulator evaluates SCPs in the order that you provide, consistent with how Organizations\n enforces SCPs. The first element must represent the organization root, and the last\n element must represent the account. Any elements between them represent organizational\n units (OUs) in descending order.
\nUse this parameter to simulate the effect of an SCP hierarchy without calling SimulatePrincipalPolicy.
" } }, "ActionNames": { "target": "com.amazonaws.iam#ActionNameListType", "traits": { "smithy.api#documentation": "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 Amazon Web Services 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 Amazon Web Services General Reference.
\nSimulation of resource-based policies isn't supported for IAM roles.
\nA 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 maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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)
Simulation of resource-based policies isn't supported for IAM roles.
\nAn ARN representing the Amazon Web Services 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, group, or role that you want to use as the simulated\n caller of the API 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 cannot specify the ARN of an assumed role, federated user, or a service\n 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 Amazon 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 Amazon 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 Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
\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#default": false, "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 SimulateCustomPolicy\n 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 Amazon Web Services 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 for IAM users only.
\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.
\nFor cross-account simulations, EvalDecisionDetails returns the decision\n for each policy type (identity-based policy, resource-based policy, and permissions\n boundary). This helps you identify which policy type is responsible for an allow or\n deny decision when policies span multiple accounts.
\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 instead.
\nContext keys are variables maintained by Amazon Web Services 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.
The IAM policy simulator evaluates statements in identity-based policies,\n service control policies (SCPs) including their condition keys and resource\n scoping, and the inputs that you provide during simulation. The policy\n simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies\n against your live Amazon Web Services environment after testing using the policy simulator to\n confirm that you have the desired results. For more information about using the\n policy simulator, see Testing IAM\n policies with the IAM policy simulator in the\n IAM User Guide.
\nThe 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.
\nThe maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\nFor more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services 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 maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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 policies to exclude from the simulation. Use this parameter to test what\n the simulation result would be if a policy were removed, without changing which\n policies are actually attached to the principal identified by\n PolicySourceArn.
Each entry is a PolicyIdentifier\n that identifies one or more policies to exclude by policy type, by Amazon Resource Name\n (ARN), or by the name of an inline policy and the entity it is attached to.
\nSyntactically invalid identifiers, such as malformed ARNs or wildcards in disallowed\n positions, cause the request to fail with an InvalidInput error.\n Syntactically valid identifiers that don't match any attached policy are ignored.\n Resource control policies (RCPs) are not supported in this release; identifiers that\n target RCPs are also ignored.
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 Amazon Web Services 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 Amazon Web Services General Reference.
\nSimulation of resource-based policies isn't supported for IAM roles.
\nA 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 maximum length of the policy document that you can pass in this operation,\n including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
\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)
Simulation of resource-based policies isn't supported for IAM roles.
\nAn Amazon Web Services 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, group, or role that you want to specify as the simulated\n caller of the API operations. If you do not specify a CallerArn, it\n defaults to the ARN of the user, group, or role that you specify in\n PolicySourceArn. If you include both a PolicySourceArn\n (for example, arn:aws:iam::123456789012:user/David) and a\n CallerArn (for example,\n arn:aws:iam::123456789012:user/Bob), the result is that you simulate\n calling the API operations as Bob, as if Bob had David's policies.
You can specify the ARN of an IAM user, group, or role. You cannot specify the ARN\n of an 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, group, or role. This\n is required so that the resource-based policy's Principal element has a\n value to use in evaluating the policy.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "ContextEntries": { "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 Amazon 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 Amazon 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 Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
\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 Amazon Resource Name (ARN) of the role template that the role was created\n from.
", "smithy.api#required": {} } }, "TemplateMinorVersion": { "target": "com.amazonaws.iam#integerType", "traits": { "smithy.api#documentation": "The minor version of the role template that was used to create the role.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the role template that a role was created from.
" } }, "com.amazonaws.iam#Statement": { "type": "structure", "members": { "SourcePolicyId": { "target": "com.amazonaws.iam#PolicyIdentifierType", "traits": { "smithy.api#documentation": "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.
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" }, "output": { "target": "smithy.api#Unit" }, "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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagMFADeviceRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagOpenIDConnectProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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 identity-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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagRoleRequest" }, "output": { "target": "smithy.api#Unit" }, "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 Amazon Web Services 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.
\nAmazon Web Services 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.
", "smithy.api#examples": [ { "title": "To add a tag key and value to an IAM role", "documentation": "The following example shows how to add tags to an existing role.", "input": { "RoleName": "taggedrole", "Tags": [ { "Key": "Dept", "Value": "Accounting" }, { "Key": "CostCenter", "Value": "12345" } ] } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagSAMLProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#TagServerCertificateRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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 Amazon Web Services 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.
\nAmazon Web Services 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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#TagTemplate": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.iam#tagTemplateKeyType", "traits": { "smithy.api#documentation": "The key name of the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.iam#tagTemplateValueType", "traits": { "smithy.api#documentation": "The value associated with the tag key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a tag that is applied to roles that are created from a role template. The key\n and value can include @{parameter} placeholders that are replaced with\n template parameter values when the role is created.
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 identity-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 Amazon Web Services 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.
\nAmazon Web Services 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.
", "smithy.api#examples": [ { "title": "To add a tag key and value to an IAM user", "documentation": "The following example shows how to add tags to an existing user.", "input": { "UserName": "anika", "Tags": [ { "Key": "Dept", "Value": "Accounting" }, { "Key": "CostCenter", "Value": "12345" } ] } } ] } }, "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 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": "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": {} } } }, "traits": { "smithy.api#input": {} } }, "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\u00a0ISO 8601 date-time\n format, when an authenticated entity most recently attempted to access the\n tracked service. Amazon Web Services does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking 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. Amazon Web Services does not report unauthenticated requests.
\nThis field is null if no IAM entities attempted to access the service within the\n tracking period.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the most recent attempt to access an action within the\n 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": { "aws.protocols#awsQueryError": { "code": "UnmodifiableEntity", "httpResponseCode": 400 }, "smithy.api#documentation": "The request was rejected because service-linked roles are protected Amazon Web Services resources. Only\n the service that depends on the service-linked role can modify or delete the role on your\n behalf. The error message includes the name of the service that depends on this service-linked\n role. You must request the change through that service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iam#UnrecognizedPublicKeyEncodingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iam#unrecognizedPublicKeyEncodingMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "UnrecognizedPublicKeyEncoding", "httpResponseCode": 400 }, "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" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagMFADevice": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagMFADeviceRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagOpenIDConnectProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagOpenIDConnectProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagRoleRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
", "smithy.api#examples": [ { "title": "To remove a tag from an IAM role", "documentation": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.", "input": { "RoleName": "taggedrole", "TagKeys": [ "Dept" ] } } ] } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagSAMLProvider": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagSAMLProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagServerCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagServerCertificateRequest" }, "output": { "target": "smithy.api#Unit" }, "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 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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UntagUser": { "type": "operation", "input": { "target": "com.amazonaws.iam#UntagUserRequest" }, "output": { "target": "smithy.api#Unit" }, "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.
", "smithy.api#examples": [ { "title": "To remove a tag from an IAM user", "documentation": "The following example shows how to remove tags that are attached to a user named 'anika'.", "input": { "UserName": "anika", "TagKeys": [ "Dept" ] } } ] } }, "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 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": {} } }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateAccessKeyRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "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 Amazon Web Services access key ID used to sign the request. If a temporary access key is\n used, then UserName is required. If a long-term key is assigned to the\n user, then UserName is not required. This operation works for access keys\n under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user\n credentials even if the Amazon Web Services account has no associated users.
For information about rotating keys, see Managing keys and certificates\n in the IAM User Guide.
", "smithy.api#examples": [ { "title": "To activate or deactivate an access key for an IAM user", "documentation": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", "input": { "UserName": "Bob", "Status": "Inactive", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" } } ] } }, "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 Amazon Web Services, while Inactive\n means that the key cannot be used.
Updates the password policy settings for the Amazon Web Services account.
\nThis operation does not support partial updates. No parameters are required, but\n if you do not specify a parameter, that parameter's value reverts to its default\n value. See the Request Parameters section for each\n parameter's default value. Also note that some parameters do not allow the default\n parameter to be explicitly set. Instead, to invoke the default value, do not include\n that 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.
", "smithy.api#examples": [ { "title": "To set or change the current account password policy", "documentation": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", "input": { "MinimumPasswordLength": 8, "RequireNumbers": true } } ] } }, "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 Amazon Web Services Management Console to change their own\n passwords. For more information, see Permitting\n IAM users to change their own passwords in the\n 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 who are accessing the account via the Amazon Web Services Management Console from setting a\n new console password after their password has expired. The IAM user cannot access the\n console 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.
In the Amazon Web Services Management Console, the custom password policy option Allow\n users to change their own password gives IAM users permissions to\n iam:ChangePassword for only their user and to the\n iam:GetAccountPasswordPolicy action. This option does not attach a\n permissions policy to each user, rather the permissions are applied at the\n account-level for all users by IAM. IAM users with\n iam:ChangePassword permission and active access keys can reset\n their own expired console password using the CLI or API.
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.
", "smithy.api#examples": [ { "title": "To update the trust policy for an IAM role", "documentation": "The following command updates the role trust policy for the role named Test-Role:", "input": { "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", "RoleName": "S3AccessForEC2Instances" } } ] } }, "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 CloudFormation\n templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to\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 an existing delegation request with additional information. When the delegation\n request is updated, it reaches the PENDING_APPROVAL state.\n
Once a delegation request has an owner, that owner gets a default permission to update the\n delegation request. For more details, see\n \n Managing Permissions for Delegation Requests.\n
" } }, "com.amazonaws.iam#UpdateDelegationRequestRequest": { "type": "structure", "members": { "DelegationRequestId": { "target": "com.amazonaws.iam#delegationRequestIdType", "traits": { "smithy.api#documentation": "The unique identifier of the delegation request to update.
", "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.iam#notesType", "traits": { "smithy.api#documentation": "Additional notes or comments to add to the delegation request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateGroup": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "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\".
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateLoginProfile": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateLoginProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, { "target": "com.amazonaws.iam#InvalidInputException" }, { "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 or the maximum sign-in session duration for the specified\n IAM user. You can use the CLI, the Amazon Web Services\n API, or the Users page in the IAM console to change\n the password for any IAM user. Use ChangePassword to\n change your own password in the My Security Credentials\n page in the Amazon Web Services Management Console.
\nFor more information about modifying passwords, see Managing passwords in the\n IAM User Guide.
", "smithy.api#examples": [ { "title": "To change the password for an IAM user", "documentation": "The following command creates or changes the password for the IAM user named Bob.", "input": { "UserName": "Bob", "Password": "SomeKindOfPassword123!@#" } } ] } }, "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 Amazon Web Services 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.
" } }, "MaxSigninSessionDuration": { "target": "com.amazonaws.iam#maxSigninSessionDurationType", "traits": { "smithy.api#documentation": "The maximum duration (in seconds) of an Amazon Web Services Sign-In session for the specified\n IAM user. This setting can have a value from 1 hour (3600 seconds) to 90 days (7776000\n seconds), inclusive, and replaces any value currently configured for the user.
\nIf you omit both this parameter and ResetMaxSigninSessionDuration, the\n current setting is unchanged. You cannot specify this parameter and set\n ResetMaxSigninSessionDuration to true in the same request.\n If you update only the sign-in session duration, the user's password and\n PasswordResetRequired setting do not change.
Changes to this setting apply to new sign-in sessions. Sessions that are already\n established are not affected.
\nThis setting is not supported for the root user.
\nSpecifies whether to clear the maximum sign-in session duration for the specified\n IAM user. Set this value to true to return the setting to its unset\n state, so that the existing sign-in session behavior applies. When the setting is unset,\n the user's MaxSigninSessionDuration is omitted from responses.
If you set this value to false or omit it, the current setting is not\n cleared. You cannot set this value to true and specify\n MaxSigninSessionDuration in the same request. Clearing a setting that\n is already unset has no effect.
Updates the configuration of an existing IAM OpenID Connect (OIDC) identity provider\n resource object. Use this operation to set, change, or remove the trusted identity\n propagation context provider, and to associate or disassociate an IAM Identity Center\n instance with the provider.
\nThis operation does not update the OIDC provider's server certificate thumbprints.\n Thumbprints are managed only by the UpdateOpenIDConnectProviderThumbprint operation. To change a provider's\n thumbprints, call that operation instead.
\nTo remove a configuration rather than replace it, use the\n RemoveContextProvider and RemoveIdentityCenterInstance\n parameters. For each configuration, provide either the new value or the corresponding\n Remove flag in a single request, but not both. For example, specifying\n both ContextProvider and RemoveContextProvider in the same\n request is not allowed.
A single request can change either the context provider or the IAM Identity Center\n association, but not both. To change both, make separate\n UpdateOpenIDConnectProvider requests. To remove the context provider,\n first remove the IAM Identity Center association in a separate request.
To control who can configure trusted identity propagation on an OIDC provider, use the\n iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM\n policies. The Request keys contain the values in the request. The\n Resource keys contain the values stored on the provider.
The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update.\n 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 Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "ContextProvider": { "target": "com.amazonaws.iam#ContextProvider", "traits": { "smithy.api#documentation": "The trusted identity propagation context provider configuration to set on the OIDC\n provider. This configuration defines the subject mapping and the source-to-target key\n mappings that are used when trusted context is injected. For more information, see ContextProvider.
\nTo remove the existing context provider instead of replacing it, use\n RemoveContextProvider. Do not specify both ContextProvider\n and RemoveContextProvider in the same request.
The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with\n the OIDC provider.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
\nTo disassociate the currently associated instance instead of changing it, use\n RemoveIdentityCenterInstance. Do not specify both\n IdentityCenterInstanceArn and\n RemoveIdentityCenterInstance in the same request.
Specifies whether to remove the existing context provider configuration from the OIDC\n provider. Set this value to true to remove the context provider.
This parameter is mutually exclusive with ContextProvider. In a single\n request, specify either a new ContextProvider value or\n RemoveContextProvider, but not both.
Specifies whether to disassociate the IAM Identity Center instance from the OIDC\n provider. Set this value to true to remove the association.
This parameter is mutually exclusive with IdentityCenterInstanceArn. In a\n single request, specify either a new IdentityCenterInstanceArn value or\n RemoveIdentityCenterInstance, but not both.
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 certificate\n 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.
\nAmazon Web Services secures communication with OIDC identity providers (IdPs) using our library of\n trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS)\n endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed\n by one of these trusted CAs, only then we secure communication using the thumbprints set\n in the IdP's configuration.
\nTrust for the OIDC provider is derived from the provider 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 Amazon Web Services 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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateRole": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateRoleRequest" }, "output": { "target": "com.amazonaws.iam#UpdateRoleResponse" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "target": "com.amazonaws.iam#NoSuchEntityException" }, { "target": "com.amazonaws.iam#ServiceFailureException" }, { "target": "com.amazonaws.iam#UnmodifiableEntityException" } ], "traits": { "smithy.api#documentation": "Updates the description, maximum session duration, or maximum sign-in session duration\n of a role. You cannot change the maximum sign-in session duration of a service-linked\n 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": {} } } }, "traits": { "smithy.api#input": {} } }, "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.
" } } }, "traits": { "smithy.api#output": {} } }, "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 value 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 CLI or API can use the\n DurationSeconds API parameter or the duration-seconds\n CLI 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.
IAM role credentials provided by Amazon EC2 instances assigned to the role are not\n subject to the specified maximum session duration.
\nThe maximum duration (in seconds) of an Amazon Web Services Sign-In session for users who sign in\n with the specified role. This setting can have a value from 1 hour (3600 seconds) to 90\n days (7776000 seconds), inclusive, and replaces any value currently configured for the\n role. This setting is independent of MaxSessionDuration.
If you omit both this parameter and ResetMaxSigninSessionDuration, the\n current setting is unchanged. You cannot specify this parameter and set\n ResetMaxSigninSessionDuration to true in the same\n request.
Changes to this setting apply to new sign-in sessions. Sessions that are already\n established are not affected.
\nYou cannot set this value on a service-linked role.
\nSpecifies whether to clear the role's maximum sign-in session duration. Set this value\n to true to return the setting to its unset state, so that the existing\n sign-in session behavior applies. When the setting is unset, the role's\n MaxSigninSessionDuration is omitted from responses.
If you set this value to false or omit it, the current setting is not\n cleared. You cannot set this value to true and specify\n MaxSigninSessionDuration in the same request. Clearing a setting that\n is already unset has no effect.
You cannot reset this value on a service-linked role.
\nUpdates the metadata document, SAML encryption settings, and private keys for an\n existing SAML provider. To rotate private keys, add your new private key and then remove\n the old key in a separate request.
\nYou can also use this operation to set, change, or remove the trusted identity\n propagation context provider, and to associate or disassociate an IAM Identity Center\n instance with the provider. To remove a configuration rather than replace it, use the\n RemoveContextProvider and RemoveIdentityCenterInstance\n parameters. For each configuration, provide either the new value or the corresponding\n Remove flag in a single request, but not both.
A single request can change either the context provider or the provider metadata, but\n not both. Provider metadata includes the SAML metadata document, assertion encryption\n mode, private keys, and IAM Identity Center association. To change both, make separate\n UpdateSAMLProvider requests. To remove the context provider, first\n remove the IAM Identity Center association in a separate request.
To control who can configure trusted identity propagation on a SAML provider, use the\n iam:EnableIdentityPropagation, iam:EnableIdentityCenterAssociation, iam:RequestIdentityProviderIssuers, iam:ResourceIdentityProviderIssuers, iam:RequestIdentityCenterInstanceArn, and iam:ResourceIdentityCenterInstanceArn condition keys in IAM\n policies. The Request keys contain the values in the request. The\n Resource keys contain the values stored on the provider.
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 IdP.
" } }, "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 Amazon Web Services General Reference.
", "smithy.api#required": {} } }, "AssertionEncryptionMode": { "target": "com.amazonaws.iam#assertionEncryptionModeType", "traits": { "smithy.api#documentation": "Specifies the encryption setting for the SAML provider.
" } }, "AddPrivateKey": { "target": "com.amazonaws.iam#privateKeyType", "traits": { "smithy.api#documentation": "Specifies the new private key from your external identity provider. The private key\n must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML\n assertions.
" } }, "RemovePrivateKey": { "target": "com.amazonaws.iam#privateKeyIdType", "traits": { "smithy.api#documentation": "The Key ID of the private key to remove.
" } }, "ContextProvider": { "target": "com.amazonaws.iam#ContextProvider", "traits": { "smithy.api#documentation": "The trusted identity propagation context provider configuration to associate with the\n SAML provider. This replaces the existing context provider configuration. For more\n information, see ContextProvider.
" } }, "IdentityCenterInstanceArn": { "target": "com.amazonaws.iam#identityCenterInstanceArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with\n the SAML provider.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
" } }, "RemoveContextProvider": { "target": "com.amazonaws.iam#booleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether to remove the existing trusted identity propagation context provider\n configuration from the SAML provider. When set to true, the context\n provider is removed. This parameter is mutually exclusive with\n ContextProvider.
Specifies whether to disassociate the IAM Identity Center instance from the SAML\n provider. When set to true, the instance is disassociated. This parameter\n is mutually exclusive with IdentityCenterInstanceArn.
The Amazon Resource Name (ARN) of the SAML provider that was updated.
" } } }, "traits": { "smithy.api#documentation": "Contains the response to a successful UpdateSAMLProvider\n request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#UpdateSSHPublicKey": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateSSHPublicKeyRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" }, { "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 CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the 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 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 Amazon Web Services 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: _+=,.@-
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateServiceSpecificCredential": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest" }, "output": { "target": "smithy.api#Unit" }, "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": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iam#UpdateSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UpdateSigningCertificateRequest" }, "output": { "target": "smithy.api#Unit" }, "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": "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\n certificate 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 Amazon Web Services access key ID used to sign the request. This operation\n works for access keys under the Amazon Web Services account. Consequently, you can use this operation\n to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n 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 Amazon Web Services 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\n name. 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\".
" } } }, "traits": { "smithy.api#input": {} } }, "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 CodeCommit repository. For more information about using SSH keys\n to authenticate to an CodeCommit repository, see Set up CodeCommit for\n SSH connections in the 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.
", "smithy.api#output": {} } }, "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 Amazon Web Services 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 Certificate Manager to\n provision, manage, and deploy your server certificates. With ACM you can request a\n certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for\n you. Certificates provided by ACM are free. For more information about using ACM,\n see the Certificate Manager User\n 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 Amazon Web Services 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 Amazon Web Services API\n requests in the Amazon Web Services 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 request.
", "smithy.api#output": {} } }, "com.amazonaws.iam#UploadSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iam#UploadSigningCertificateRequest" }, "output": { "target": "com.amazonaws.iam#UploadSigningCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" }, { "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 Amazon Web Services 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 Amazon Web Services access key ID used to sign the request. This operation\n works for access keys under the Amazon Web Services account. Consequently, you can use this operation\n to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated\n 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 Amazon Web Services API requests in the Amazon Web Services 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 request.
", "smithy.api#output": {} } }, "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 Amazon Web Services website.\n For a list of Amazon Web Services 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\n 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 base32-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]|-(?!-)){1,61}[a-z0-9]$" } }, "com.amazonaws.iam#accountIdType": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.iam#accountPropertiesMapType": { "type": "map", "key": { "target": "com.amazonaws.iam#accountPropertyKeyType" }, "value": { "target": "com.amazonaws.iam#accountPropertyValueType" } }, "com.amazonaws.iam#accountPropertyKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9/_-]*$" } }, "com.amazonaws.iam#accountPropertyValueType": { "type": "string", "traits": { "smithy.api#documentation": "String representation of the property value. The service will validate\n and coerce the value based on the property key's expected type.\n For example, integer properties expect numeric strings, and boolean\n properties expect \"true\" or \"false\".", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.iam#allUsers": { "type": "boolean" }, "com.amazonaws.iam#arnType": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
\nFor more information about ARNs, go to Amazon Resource Names (ARNs) in\n the Amazon Web Services General Reference.
", "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.iam#assertionEncryptionModeType": { "type": "enum", "members": { "Required": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Required" } }, "Allowed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Allowed" } } } }, "com.amazonaws.iam#assignmentStatusType": { "type": "enum", "members": { "Assigned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Assigned" } }, "Unassigned": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unassigned" } }, "Any": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Any" } } } }, "com.amazonaws.iam#attachedPoliciesListType": { "type": "list", "member": { "target": "com.amazonaws.iam#AttachedPolicy" } }, "com.amazonaws.iam#attachmentCountType": { "type": "integer" }, "com.amazonaws.iam#authenticationCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 6 }, "smithy.api#pattern": "^[\\d]+$" } }, "com.amazonaws.iam#booleanObjectType": { "type": "boolean" }, "com.amazonaws.iam#booleanType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "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#consoleDeepLinkType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.iam#contextProviderSourceKeyType": { "type": "string", "traits": { "smithy.api#documentation": "Contains a source key for a trusted identity propagation context provider. The value can be\n from 1 to 128 characters in length.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
Contains a target trusted context key for a trusted identity propagation context provider.\n The value can be from 1 to 128 characters in length.
\nThe key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the\n following characters: _ . : / = + - @ #. It can't start or end with a space\n or contain two spaces in a row.
Contains a list of IAM groups.
\nThis data type is used as a response element in the ListGroups 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#identityCenterInstanceArnType": { "type": "string", "traits": { "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of an IAM Identity Center instance. The value\n can be from 1 to 1224 characters in length.
\nFor the format, see InstanceMetadata in the IAM Identity Center API Reference.
", "smithy.api#length": { "min": 1, "max": 1224 } } }, "com.amazonaws.iam#inlinePolicyTemplateListType": { "type": "list", "member": { "target": "com.amazonaws.iam#InlinePolicy" } }, "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" }, "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": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.iam#keyDefinitionListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ContextProviderKeyDefinition" }, "traits": { "smithy.api#documentation": "Contains a list of source-to-target key mappings for a trusted identity propagation context\n provider. The list can contain from 0 to 10 ContextProviderKeyDefinition values.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "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#localeType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 12 } } }, "com.amazonaws.iam#malformedCertificateMessage": { "type": "string" }, "com.amazonaws.iam#malformedPolicyDocumentMessage": { "type": "string" }, "com.amazonaws.iam#managedByTypeType": { "type": "enum", "members": { "Service": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Service" } } } }, "com.amazonaws.iam#managedByValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iam#managedPolicyArnListType": { "type": "list", "member": { "target": "com.amazonaws.iam#arnType" } }, "com.amazonaws.iam#mapStringReplacementValueEntry": { "type": "map", "key": { "target": "com.amazonaws.iam#stringType" }, "value": { "target": "com.amazonaws.iam#ReplacementValueEntry" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 } } }, "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#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iam#maxPasswordAgeType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1095 } } }, "com.amazonaws.iam#maxSigninSessionDurationType": { "type": "integer", "traits": { "smithy.api#documentation": "A maximum sign-in session duration in seconds. Valid values range from 3600 through 7776000, inclusive. This type is distinct from roleMaxSessionDurationType.", "smithy.api#range": { "min": 3600, "max": 7776000 } } }, "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 ListVirtualMFADevices operations.
" } }, "com.amazonaws.iam#minimumPasswordLengthType": { "type": "integer", "traits": { "smithy.api#range": { "min": 6, "max": 128 } } }, "com.amazonaws.iam#minorVersionType": { "type": "integer" }, "com.amazonaws.iam#nameConflictMessage": { "type": "string" }, "com.amazonaws.iam#noSuchEntityMessage": { "type": "string" }, "com.amazonaws.iam#notesType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "com.amazonaws.iam#notificationChannelType": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 400 }, "smithy.api#pattern": "^[a-zA-Z0-9:_.-]+$" } }, "com.amazonaws.iam#openIdIdpCommunicationErrorExceptionMessage": { "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#ownerIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^[a-zA-Z0-9:/+=,.@_-]+$" } }, "com.amazonaws.iam#parameterDefaultValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.iam#parameterDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.iam#parameterNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iam#parameterSubTypeType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.iam#parameterTypeType": { "type": "enum", "members": { "String": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "String" } }, "StringList": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StringList" } }, "Number": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Number" } }, "NumberList": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NumberList" } }, "Arn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Arn" } }, "ArnList": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ArnList" } } } }, "com.amazonaws.iam#parametersDefinitionListType": { "type": "list", "member": { "target": "com.amazonaws.iam#ParameterDefinition" } }, "com.amazonaws.iam#passwordPolicyViolationMessage": { "type": "string" }, "com.amazonaws.iam#passwordReusePreventionType": { "type": "integer", "traits": { "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-\\u007E]+\\u002F)$" } }, "com.amazonaws.iam#permissionCheckResultType": { "type": "enum", "members": { "ALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOWED" } }, "DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENIED" } }, "UNSURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSURE" } } } }, "com.amazonaws.iam#permissionCheckStatusType": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.iam#permissionType": { "type": "string" }, "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": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER" } }, "ROLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLE" } }, "GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GROUP" } } } }, "com.amazonaws.iam#policyParameterListType": { "type": "list", "member": { "target": "com.amazonaws.iam#PolicyParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.iam#policyParameterNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 256 }, "smithy.api#pattern": "^[ -~]+$" } }, "com.amazonaws.iam#policyParameterValueType": { "type": "string", "traits": { "smithy.api#pattern": "^[ -~]+$" } }, "com.amazonaws.iam#policyParameterValuesListType": { "type": "list", "member": { "target": "com.amazonaws.iam#policyParameterValueType" } }, "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": "enum", "members": { "All": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "All" } }, "AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS" } }, "Local": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Local" } } } }, "com.amazonaws.iam#policyType": { "type": "enum", "members": { "INLINE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INLINE" } }, "MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED" } } } }, "com.amazonaws.iam#policyVersionIdType": { "type": "string", "traits": { "smithy.api#pattern": "^v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?$" } }, "com.amazonaws.iam#privateKeyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 22, "max": 64 }, "smithy.api#pattern": "^[A-Z0-9]+$" } }, "com.amazonaws.iam#privateKeyList": { "type": "list", "member": { "target": "com.amazonaws.iam#SAMLPrivateKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "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#redirectUrlType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^http(s?)://[a-zA-Z0-9._/-]*(\\?[a-zA-Z0-9._=&-]*)?(#[a-zA-Z0-9._/-]*)?$" } }, "com.amazonaws.iam#replacementValueListType": { "type": "list", "member": { "target": "com.amazonaws.iam#stringType" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.iam#reportGenerationLimitExceededMessage": { "type": "string" }, "com.amazonaws.iam#requestMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "com.amazonaws.iam#requestorNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 30 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "com.amazonaws.iam#requestorWorkflowIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 400 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+$" } }, "com.amazonaws.iam#responseMarkerType": { "type": "string" }, "com.amazonaws.iam#roleDescriptionPatternType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.iam#roleDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "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 operation.
" } }, "com.amazonaws.iam#roleMaxSessionDurationType": { "type": "integer", "traits": { "smithy.api#range": { "min": 3600, "max": 43200 } } }, "com.amazonaws.iam#roleModifiedMessage": { "type": "string" }, "com.amazonaws.iam#roleNamePatternType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iam#roleNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#rolePathPatternType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^/[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*/$" } }, "com.amazonaws.iam#rolePermissionRestrictionArnListType": { "type": "list", "member": { "target": "com.amazonaws.iam#arnType" } }, "com.amazonaws.iam#roleTemplateDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" } }, "com.amazonaws.iam#roleTemplateDisabledMessage": { "type": "string" }, "com.amazonaws.iam#roleTemplateNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "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#serviceCredentialAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^[\\w+=,.@-]+$" } }, "com.amazonaws.iam#serviceCredentialSecret": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "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": 0, "max": 200 }, "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.iam#sessionDurationType": { "type": "integer", "traits": { "smithy.api#range": { "min": 300, "max": 43200 } } }, "com.amazonaws.iam#sortKeyType": { "type": "enum", "members": { "SERVICE_NAMESPACE_ASCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_NAMESPACE_ASCENDING" } }, "SERVICE_NAMESPACE_DESCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_NAMESPACE_DESCENDING" } }, "LAST_AUTHENTICATED_TIME_ASCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST_AUTHENTICATED_TIME_ASCENDING" } }, "LAST_AUTHENTICATED_TIME_DESCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAST_AUTHENTICATED_TIME_DESCENDING" } } } }, "com.amazonaws.iam#stateType": { "type": "enum", "members": { "UNASSIGNED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNASSIGNED" } }, "ASSIGNED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSIGNED" } }, "PENDING_APPROVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_APPROVAL" } }, "FINALIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FINALIZED" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } } } }, "com.amazonaws.iam#statusType": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Inactive": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Inactive" } }, "Expired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Expired" } } } }, "com.amazonaws.iam#stringType": { "type": "string" }, "com.amazonaws.iam#subjectTypeValueType": { "type": "string", "traits": { "smithy.api#documentation": "Contains a static subject type value for a trusted identity propagation context provider,\n such as user or workload. The value can be from 0 to 128\n characters in length. An empty value indicates that no static subject type is set.
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\n 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+=,.@-]+$" } } } }