Documentation ¶
Overview ¶
Package iam provides the API client, operations, and parameter types for AWS Identity and Access Management.
Identity and Access Management ¶
Identity and Access Management (IAM) is a web service for securely controlling access to Amazon Web Services services. With IAM, you can centrally manage users, security credentials such as access keys, and permissions that control which Amazon Web Services resources users and applications can access. For more information about IAM, see Identity and Access Management (IAM)and the Identity and Access Management User Guide.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddClientIDToOpenIDConnectProviderInput
- type AddClientIDToOpenIDConnectProviderOutput
- type AddRoleToInstanceProfileInput
- type AddRoleToInstanceProfileOutput
- type AddUserToGroupInput
- type AddUserToGroupOutput
- type AttachGroupPolicyInput
- type AttachGroupPolicyOutput
- type AttachRolePolicyInput
- type AttachRolePolicyOutput
- type AttachUserPolicyInput
- type AttachUserPolicyOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type ChangePasswordInput
- type ChangePasswordOutput
- type Client
- func (c *Client) AddClientIDToOpenIDConnectProvider(ctx context.Context, params *AddClientIDToOpenIDConnectProviderInput, ...) (*AddClientIDToOpenIDConnectProviderOutput, error)
- func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleToInstanceProfileInput, ...) (*AddRoleToInstanceProfileOutput, error)
- func (c *Client) AddUserToGroup(ctx context.Context, params *AddUserToGroupInput, optFns ...func(*Options)) (*AddUserToGroupOutput, error)
- func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolicyInput, optFns ...func(*Options)) (*AttachGroupPolicyOutput, error)
- func (c *Client) AttachRolePolicy(ctx context.Context, params *AttachRolePolicyInput, optFns ...func(*Options)) (*AttachRolePolicyOutput, error)
- func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyInput, optFns ...func(*Options)) (*AttachUserPolicyOutput, error)
- func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error)
- func (c *Client) CreateAccessKey(ctx context.Context, params *CreateAccessKeyInput, optFns ...func(*Options)) (*CreateAccessKeyOutput, error)
- func (c *Client) CreateAccountAlias(ctx context.Context, params *CreateAccountAliasInput, optFns ...func(*Options)) (*CreateAccountAliasOutput, error)
- func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
- func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstanceProfileInput, ...) (*CreateInstanceProfileOutput, error)
- func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProfileInput, optFns ...func(*Options)) (*CreateLoginProfileOutput, error)
- func (c *Client) CreateOpenIDConnectProvider(ctx context.Context, params *CreateOpenIDConnectProviderInput, ...) (*CreateOpenIDConnectProviderOutput, error)
- func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error)
- func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, ...) (*CreatePolicyVersionOutput, error)
- func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns ...func(*Options)) (*CreateRoleOutput, error)
- func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProviderInput, optFns ...func(*Options)) (*CreateSAMLProviderOutput, error)
- func (c *Client) CreateServiceLinkedRole(ctx context.Context, params *CreateServiceLinkedRoleInput, ...) (*CreateServiceLinkedRoleOutput, error)
- func (c *Client) CreateServiceSpecificCredential(ctx context.Context, params *CreateServiceSpecificCredentialInput, ...) (*CreateServiceSpecificCredentialOutput, error)
- func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
- func (c *Client) CreateVirtualMFADevice(ctx context.Context, params *CreateVirtualMFADeviceInput, ...) (*CreateVirtualMFADeviceOutput, error)
- func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFADeviceInput, ...) (*DeactivateMFADeviceOutput, error)
- func (c *Client) DeleteAccessKey(ctx context.Context, params *DeleteAccessKeyInput, optFns ...func(*Options)) (*DeleteAccessKeyOutput, error)
- func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAliasInput, optFns ...func(*Options)) (*DeleteAccountAliasOutput, error)
- func (c *Client) DeleteAccountPasswordPolicy(ctx context.Context, params *DeleteAccountPasswordPolicyInput, ...) (*DeleteAccountPasswordPolicyOutput, error)
- func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
- func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolicyInput, optFns ...func(*Options)) (*DeleteGroupPolicyOutput, error)
- func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, ...) (*DeleteInstanceProfileOutput, error)
- func (c *Client) DeleteLoginProfile(ctx context.Context, params *DeleteLoginProfileInput, optFns ...func(*Options)) (*DeleteLoginProfileOutput, error)
- func (c *Client) DeleteOpenIDConnectProvider(ctx context.Context, params *DeleteOpenIDConnectProviderInput, ...) (*DeleteOpenIDConnectProviderOutput, error)
- func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error)
- func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, ...) (*DeletePolicyVersionOutput, error)
- func (c *Client) DeleteRole(ctx context.Context, params *DeleteRoleInput, optFns ...func(*Options)) (*DeleteRoleOutput, error)
- func (c *Client) DeleteRolePermissionsBoundary(ctx context.Context, params *DeleteRolePermissionsBoundaryInput, ...) (*DeleteRolePermissionsBoundaryOutput, error)
- func (c *Client) DeleteRolePolicy(ctx context.Context, params *DeleteRolePolicyInput, optFns ...func(*Options)) (*DeleteRolePolicyOutput, error)
- func (c *Client) DeleteSAMLProvider(ctx context.Context, params *DeleteSAMLProviderInput, optFns ...func(*Options)) (*DeleteSAMLProviderOutput, error)
- func (c *Client) DeleteSSHPublicKey(ctx context.Context, params *DeleteSSHPublicKeyInput, optFns ...func(*Options)) (*DeleteSSHPublicKeyOutput, error)
- func (c *Client) DeleteServerCertificate(ctx context.Context, params *DeleteServerCertificateInput, ...) (*DeleteServerCertificateOutput, error)
- func (c *Client) DeleteServiceLinkedRole(ctx context.Context, params *DeleteServiceLinkedRoleInput, ...) (*DeleteServiceLinkedRoleOutput, error)
- func (c *Client) DeleteServiceSpecificCredential(ctx context.Context, params *DeleteServiceSpecificCredentialInput, ...) (*DeleteServiceSpecificCredentialOutput, error)
- func (c *Client) DeleteSigningCertificate(ctx context.Context, params *DeleteSigningCertificateInput, ...) (*DeleteSigningCertificateOutput, error)
- func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DeleteUserPermissionsBoundary(ctx context.Context, params *DeleteUserPermissionsBoundaryInput, ...) (*DeleteUserPermissionsBoundaryOutput, error)
- func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyInput, optFns ...func(*Options)) (*DeleteUserPolicyOutput, error)
- func (c *Client) DeleteVirtualMFADevice(ctx context.Context, params *DeleteVirtualMFADeviceInput, ...) (*DeleteVirtualMFADeviceOutput, error)
- func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolicyInput, optFns ...func(*Options)) (*DetachGroupPolicyOutput, error)
- func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyInput, optFns ...func(*Options)) (*DetachRolePolicyOutput, error)
- func (c *Client) DetachUserPolicy(ctx context.Context, params *DetachUserPolicyInput, optFns ...func(*Options)) (*DetachUserPolicyOutput, error)
- func (c *Client) DisableOrganizationsRootCredentialsManagement(ctx context.Context, ...) (*DisableOrganizationsRootCredentialsManagementOutput, error)
- func (c *Client) DisableOrganizationsRootSessions(ctx context.Context, params *DisableOrganizationsRootSessionsInput, ...) (*DisableOrganizationsRootSessionsOutput, error)
- func (c *Client) EnableMFADevice(ctx context.Context, params *EnableMFADeviceInput, optFns ...func(*Options)) (*EnableMFADeviceOutput, error)
- func (c *Client) EnableOrganizationsRootCredentialsManagement(ctx context.Context, params *EnableOrganizationsRootCredentialsManagementInput, ...) (*EnableOrganizationsRootCredentialsManagementOutput, error)
- func (c *Client) EnableOrganizationsRootSessions(ctx context.Context, params *EnableOrganizationsRootSessionsInput, ...) (*EnableOrganizationsRootSessionsOutput, error)
- func (c *Client) GenerateCredentialReport(ctx context.Context, params *GenerateCredentialReportInput, ...) (*GenerateCredentialReportOutput, error)
- func (c *Client) GenerateOrganizationsAccessReport(ctx context.Context, params *GenerateOrganizationsAccessReportInput, ...) (*GenerateOrganizationsAccessReportOutput, error)
- func (c *Client) GenerateServiceLastAccessedDetails(ctx context.Context, params *GenerateServiceLastAccessedDetailsInput, ...) (*GenerateServiceLastAccessedDetailsOutput, error)
- func (c *Client) GetAccessKeyLastUsed(ctx context.Context, params *GetAccessKeyLastUsedInput, ...) (*GetAccessKeyLastUsedOutput, error)
- func (c *Client) GetAccountAuthorizationDetails(ctx context.Context, params *GetAccountAuthorizationDetailsInput, ...) (*GetAccountAuthorizationDetailsOutput, error)
- func (c *Client) GetAccountPasswordPolicy(ctx context.Context, params *GetAccountPasswordPolicyInput, ...) (*GetAccountPasswordPolicyOutput, error)
- func (c *Client) GetAccountSummary(ctx context.Context, params *GetAccountSummaryInput, optFns ...func(*Options)) (*GetAccountSummaryOutput, error)
- func (c *Client) GetContextKeysForCustomPolicy(ctx context.Context, params *GetContextKeysForCustomPolicyInput, ...) (*GetContextKeysForCustomPolicyOutput, error)
- func (c *Client) GetContextKeysForPrincipalPolicy(ctx context.Context, params *GetContextKeysForPrincipalPolicyInput, ...) (*GetContextKeysForPrincipalPolicyOutput, error)
- func (c *Client) GetCredentialReport(ctx context.Context, params *GetCredentialReportInput, ...) (*GetCredentialReportOutput, error)
- func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)
- func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput, optFns ...func(*Options)) (*GetGroupPolicyOutput, error)
- func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProfileInput, optFns ...func(*Options)) (*GetInstanceProfileOutput, error)
- func (c *Client) GetLoginProfile(ctx context.Context, params *GetLoginProfileInput, optFns ...func(*Options)) (*GetLoginProfileOutput, error)
- func (c *Client) GetMFADevice(ctx context.Context, params *GetMFADeviceInput, optFns ...func(*Options)) (*GetMFADeviceOutput, error)
- func (c *Client) GetOpenIDConnectProvider(ctx context.Context, params *GetOpenIDConnectProviderInput, ...) (*GetOpenIDConnectProviderOutput, error)
- func (c *Client) GetOrganizationsAccessReport(ctx context.Context, params *GetOrganizationsAccessReportInput, ...) (*GetOrganizationsAccessReportOutput, error)
- func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error)
- func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error)
- func (c *Client) GetRole(ctx context.Context, params *GetRoleInput, optFns ...func(*Options)) (*GetRoleOutput, error)
- func (c *Client) GetRolePolicy(ctx context.Context, params *GetRolePolicyInput, optFns ...func(*Options)) (*GetRolePolicyOutput, error)
- func (c *Client) GetSAMLProvider(ctx context.Context, params *GetSAMLProviderInput, optFns ...func(*Options)) (*GetSAMLProviderOutput, error)
- func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInput, optFns ...func(*Options)) (*GetSSHPublicKeyOutput, error)
- func (c *Client) GetServerCertificate(ctx context.Context, params *GetServerCertificateInput, ...) (*GetServerCertificateOutput, error)
- func (c *Client) GetServiceLastAccessedDetails(ctx context.Context, params *GetServiceLastAccessedDetailsInput, ...) (*GetServiceLastAccessedDetailsOutput, error)
- func (c *Client) GetServiceLastAccessedDetailsWithEntities(ctx context.Context, params *GetServiceLastAccessedDetailsWithEntitiesInput, ...) (*GetServiceLastAccessedDetailsWithEntitiesOutput, error)
- func (c *Client) GetServiceLinkedRoleDeletionStatus(ctx context.Context, params *GetServiceLinkedRoleDeletionStatusInput, ...) (*GetServiceLinkedRoleDeletionStatusOutput, error)
- func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)
- func (c *Client) GetUserPolicy(ctx context.Context, params *GetUserPolicyInput, optFns ...func(*Options)) (*GetUserPolicyOutput, error)
- func (c *Client) ListAccessKeys(ctx context.Context, params *ListAccessKeysInput, optFns ...func(*Options)) (*ListAccessKeysOutput, error)
- func (c *Client) ListAccountAliases(ctx context.Context, params *ListAccountAliasesInput, optFns ...func(*Options)) (*ListAccountAliasesOutput, error)
- func (c *Client) ListAttachedGroupPolicies(ctx context.Context, params *ListAttachedGroupPoliciesInput, ...) (*ListAttachedGroupPoliciesOutput, error)
- func (c *Client) ListAttachedRolePolicies(ctx context.Context, params *ListAttachedRolePoliciesInput, ...) (*ListAttachedRolePoliciesOutput, error)
- func (c *Client) ListAttachedUserPolicies(ctx context.Context, params *ListAttachedUserPoliciesInput, ...) (*ListAttachedUserPoliciesOutput, error)
- func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntitiesForPolicyInput, ...) (*ListEntitiesForPolicyOutput, error)
- func (c *Client) ListGroupPolicies(ctx context.Context, params *ListGroupPoliciesInput, optFns ...func(*Options)) (*ListGroupPoliciesOutput, error)
- func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
- func (c *Client) ListGroupsForUser(ctx context.Context, params *ListGroupsForUserInput, optFns ...func(*Options)) (*ListGroupsForUserOutput, error)
- func (c *Client) ListInstanceProfileTags(ctx context.Context, params *ListInstanceProfileTagsInput, ...) (*ListInstanceProfileTagsOutput, error)
- func (c *Client) ListInstanceProfiles(ctx context.Context, params *ListInstanceProfilesInput, ...) (*ListInstanceProfilesOutput, error)
- func (c *Client) ListInstanceProfilesForRole(ctx context.Context, params *ListInstanceProfilesForRoleInput, ...) (*ListInstanceProfilesForRoleOutput, error)
- func (c *Client) ListMFADeviceTags(ctx context.Context, params *ListMFADeviceTagsInput, optFns ...func(*Options)) (*ListMFADeviceTagsOutput, error)
- func (c *Client) ListMFADevices(ctx context.Context, params *ListMFADevicesInput, optFns ...func(*Options)) (*ListMFADevicesOutput, error)
- func (c *Client) ListOpenIDConnectProviderTags(ctx context.Context, params *ListOpenIDConnectProviderTagsInput, ...) (*ListOpenIDConnectProviderTagsOutput, error)
- func (c *Client) ListOpenIDConnectProviders(ctx context.Context, params *ListOpenIDConnectProvidersInput, ...) (*ListOpenIDConnectProvidersOutput, error)
- func (c *Client) ListOrganizationsFeatures(ctx context.Context, params *ListOrganizationsFeaturesInput, ...) (*ListOrganizationsFeaturesOutput, error)
- func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error)
- func (c *Client) ListPoliciesGrantingServiceAccess(ctx context.Context, params *ListPoliciesGrantingServiceAccessInput, ...) (*ListPoliciesGrantingServiceAccessOutput, error)
- func (c *Client) ListPolicyTags(ctx context.Context, params *ListPolicyTagsInput, optFns ...func(*Options)) (*ListPolicyTagsOutput, error)
- func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error)
- func (c *Client) ListRolePolicies(ctx context.Context, params *ListRolePoliciesInput, optFns ...func(*Options)) (*ListRolePoliciesOutput, error)
- func (c *Client) ListRoleTags(ctx context.Context, params *ListRoleTagsInput, optFns ...func(*Options)) (*ListRoleTagsOutput, error)
- func (c *Client) ListRoles(ctx context.Context, params *ListRolesInput, optFns ...func(*Options)) (*ListRolesOutput, error)
- func (c *Client) ListSAMLProviderTags(ctx context.Context, params *ListSAMLProviderTagsInput, ...) (*ListSAMLProviderTagsOutput, error)
- func (c *Client) ListSAMLProviders(ctx context.Context, params *ListSAMLProvidersInput, optFns ...func(*Options)) (*ListSAMLProvidersOutput, error)
- func (c *Client) ListSSHPublicKeys(ctx context.Context, params *ListSSHPublicKeysInput, optFns ...func(*Options)) (*ListSSHPublicKeysOutput, error)
- func (c *Client) ListServerCertificateTags(ctx context.Context, params *ListServerCertificateTagsInput, ...) (*ListServerCertificateTagsOutput, error)
- func (c *Client) ListServerCertificates(ctx context.Context, params *ListServerCertificatesInput, ...) (*ListServerCertificatesOutput, error)
- func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *ListServiceSpecificCredentialsInput, ...) (*ListServiceSpecificCredentialsOutput, error)
- func (c *Client) ListSigningCertificates(ctx context.Context, params *ListSigningCertificatesInput, ...) (*ListSigningCertificatesOutput, error)
- func (c *Client) ListUserPolicies(ctx context.Context, params *ListUserPoliciesInput, optFns ...func(*Options)) (*ListUserPoliciesOutput, error)
- func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, optFns ...func(*Options)) (*ListUserTagsOutput, error)
- func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
- func (c *Client) ListVirtualMFADevices(ctx context.Context, params *ListVirtualMFADevicesInput, ...) (*ListVirtualMFADevicesOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput, optFns ...func(*Options)) (*PutGroupPolicyOutput, error)
- func (c *Client) PutRolePermissionsBoundary(ctx context.Context, params *PutRolePermissionsBoundaryInput, ...) (*PutRolePermissionsBoundaryOutput, error)
- func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, optFns ...func(*Options)) (*PutRolePolicyOutput, error)
- func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUserPermissionsBoundaryInput, ...) (*PutUserPermissionsBoundaryOutput, error)
- func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, optFns ...func(*Options)) (*PutUserPolicyOutput, error)
- func (c *Client) RemoveClientIDFromOpenIDConnectProvider(ctx context.Context, params *RemoveClientIDFromOpenIDConnectProviderInput, ...) (*RemoveClientIDFromOpenIDConnectProviderOutput, error)
- func (c *Client) RemoveRoleFromInstanceProfile(ctx context.Context, params *RemoveRoleFromInstanceProfileInput, ...) (*RemoveRoleFromInstanceProfileOutput, error)
- func (c *Client) RemoveUserFromGroup(ctx context.Context, params *RemoveUserFromGroupInput, ...) (*RemoveUserFromGroupOutput, error)
- func (c *Client) ResetServiceSpecificCredential(ctx context.Context, params *ResetServiceSpecificCredentialInput, ...) (*ResetServiceSpecificCredentialOutput, error)
- func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInput, optFns ...func(*Options)) (*ResyncMFADeviceOutput, error)
- func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, ...) (*SetDefaultPolicyVersionOutput, error)
- func (c *Client) SetSecurityTokenServicePreferences(ctx context.Context, params *SetSecurityTokenServicePreferencesInput, ...) (*SetSecurityTokenServicePreferencesOutput, error)
- func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCustomPolicyInput, ...) (*SimulateCustomPolicyOutput, error)
- func (c *Client) SimulatePrincipalPolicy(ctx context.Context, params *SimulatePrincipalPolicyInput, ...) (*SimulatePrincipalPolicyOutput, error)
- func (c *Client) TagInstanceProfile(ctx context.Context, params *TagInstanceProfileInput, optFns ...func(*Options)) (*TagInstanceProfileOutput, error)
- func (c *Client) TagMFADevice(ctx context.Context, params *TagMFADeviceInput, optFns ...func(*Options)) (*TagMFADeviceOutput, error)
- func (c *Client) TagOpenIDConnectProvider(ctx context.Context, params *TagOpenIDConnectProviderInput, ...) (*TagOpenIDConnectProviderOutput, error)
- func (c *Client) TagPolicy(ctx context.Context, params *TagPolicyInput, optFns ...func(*Options)) (*TagPolicyOutput, error)
- func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...func(*Options)) (*TagRoleOutput, error)
- func (c *Client) TagSAMLProvider(ctx context.Context, params *TagSAMLProviderInput, optFns ...func(*Options)) (*TagSAMLProviderOutput, error)
- func (c *Client) TagServerCertificate(ctx context.Context, params *TagServerCertificateInput, ...) (*TagServerCertificateOutput, error)
- func (c *Client) TagUser(ctx context.Context, params *TagUserInput, optFns ...func(*Options)) (*TagUserOutput, error)
- func (c *Client) UntagInstanceProfile(ctx context.Context, params *UntagInstanceProfileInput, ...) (*UntagInstanceProfileOutput, error)
- func (c *Client) UntagMFADevice(ctx context.Context, params *UntagMFADeviceInput, optFns ...func(*Options)) (*UntagMFADeviceOutput, error)
- func (c *Client) UntagOpenIDConnectProvider(ctx context.Context, params *UntagOpenIDConnectProviderInput, ...) (*UntagOpenIDConnectProviderOutput, error)
- func (c *Client) UntagPolicy(ctx context.Context, params *UntagPolicyInput, optFns ...func(*Options)) (*UntagPolicyOutput, error)
- func (c *Client) UntagRole(ctx context.Context, params *UntagRoleInput, optFns ...func(*Options)) (*UntagRoleOutput, error)
- func (c *Client) UntagSAMLProvider(ctx context.Context, params *UntagSAMLProviderInput, optFns ...func(*Options)) (*UntagSAMLProviderOutput, error)
- func (c *Client) UntagServerCertificate(ctx context.Context, params *UntagServerCertificateInput, ...) (*UntagServerCertificateOutput, error)
- func (c *Client) UntagUser(ctx context.Context, params *UntagUserInput, optFns ...func(*Options)) (*UntagUserOutput, error)
- func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInput, optFns ...func(*Options)) (*UpdateAccessKeyOutput, error)
- func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *UpdateAccountPasswordPolicyInput, ...) (*UpdateAccountPasswordPolicyOutput, error)
- func (c *Client) UpdateAssumeRolePolicy(ctx context.Context, params *UpdateAssumeRolePolicyInput, ...) (*UpdateAssumeRolePolicyOutput, error)
- func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)
- func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProfileInput, optFns ...func(*Options)) (*UpdateLoginProfileOutput, error)
- func (c *Client) UpdateOpenIDConnectProviderThumbprint(ctx context.Context, params *UpdateOpenIDConnectProviderThumbprintInput, ...) (*UpdateOpenIDConnectProviderThumbprintOutput, error)
- func (c *Client) UpdateRole(ctx context.Context, params *UpdateRoleInput, optFns ...func(*Options)) (*UpdateRoleOutput, error)
- func (c *Client) UpdateRoleDescription(ctx context.Context, params *UpdateRoleDescriptionInput, ...) (*UpdateRoleDescriptionOutput, error)
- func (c *Client) UpdateSAMLProvider(ctx context.Context, params *UpdateSAMLProviderInput, optFns ...func(*Options)) (*UpdateSAMLProviderOutput, error)
- func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublicKeyInput, optFns ...func(*Options)) (*UpdateSSHPublicKeyOutput, error)
- func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServerCertificateInput, ...) (*UpdateServerCertificateOutput, error)
- func (c *Client) UpdateServiceSpecificCredential(ctx context.Context, params *UpdateServiceSpecificCredentialInput, ...) (*UpdateServiceSpecificCredentialOutput, error)
- func (c *Client) UpdateSigningCertificate(ctx context.Context, params *UpdateSigningCertificateInput, ...) (*UpdateSigningCertificateOutput, error)
- func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
- func (c *Client) UploadSSHPublicKey(ctx context.Context, params *UploadSSHPublicKeyInput, optFns ...func(*Options)) (*UploadSSHPublicKeyOutput, error)
- func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServerCertificateInput, ...) (*UploadServerCertificateOutput, error)
- func (c *Client) UploadSigningCertificate(ctx context.Context, params *UploadSigningCertificateInput, ...) (*UploadSigningCertificateOutput, error)
- type CreateAccessKeyInput
- type CreateAccessKeyOutput
- type CreateAccountAliasInput
- type CreateAccountAliasOutput
- type CreateGroupInput
- type CreateGroupOutput
- type CreateInstanceProfileInput
- type CreateInstanceProfileOutput
- type CreateLoginProfileInput
- type CreateLoginProfileOutput
- type CreateOpenIDConnectProviderInput
- type CreateOpenIDConnectProviderOutput
- type CreatePolicyInput
- type CreatePolicyOutput
- type CreatePolicyVersionInput
- type CreatePolicyVersionOutput
- type CreateRoleInput
- type CreateRoleOutput
- type CreateSAMLProviderInput
- type CreateSAMLProviderOutput
- type CreateServiceLinkedRoleInput
- type CreateServiceLinkedRoleOutput
- type CreateServiceSpecificCredentialInput
- type CreateServiceSpecificCredentialOutput
- type CreateUserInput
- type CreateUserOutput
- type CreateVirtualMFADeviceInput
- type CreateVirtualMFADeviceOutput
- type DeactivateMFADeviceInput
- type DeactivateMFADeviceOutput
- type DeleteAccessKeyInput
- type DeleteAccessKeyOutput
- type DeleteAccountAliasInput
- type DeleteAccountAliasOutput
- type DeleteAccountPasswordPolicyInput
- type DeleteAccountPasswordPolicyOutput
- type DeleteGroupInput
- type DeleteGroupOutput
- type DeleteGroupPolicyInput
- type DeleteGroupPolicyOutput
- type DeleteInstanceProfileInput
- type DeleteInstanceProfileOutput
- type DeleteLoginProfileInput
- type DeleteLoginProfileOutput
- type DeleteOpenIDConnectProviderInput
- type DeleteOpenIDConnectProviderOutput
- type DeletePolicyInput
- type DeletePolicyOutput
- type DeletePolicyVersionInput
- type DeletePolicyVersionOutput
- type DeleteRoleInput
- type DeleteRoleOutput
- type DeleteRolePermissionsBoundaryInput
- type DeleteRolePermissionsBoundaryOutput
- type DeleteRolePolicyInput
- type DeleteRolePolicyOutput
- type DeleteSAMLProviderInput
- type DeleteSAMLProviderOutput
- type DeleteSSHPublicKeyInput
- type DeleteSSHPublicKeyOutput
- type DeleteServerCertificateInput
- type DeleteServerCertificateOutput
- type DeleteServiceLinkedRoleInput
- type DeleteServiceLinkedRoleOutput
- type DeleteServiceSpecificCredentialInput
- type DeleteServiceSpecificCredentialOutput
- type DeleteSigningCertificateInput
- type DeleteSigningCertificateOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteUserPermissionsBoundaryInput
- type DeleteUserPermissionsBoundaryOutput
- type DeleteUserPolicyInput
- type DeleteUserPolicyOutput
- type DeleteVirtualMFADeviceInput
- type DeleteVirtualMFADeviceOutput
- type DetachGroupPolicyInput
- type DetachGroupPolicyOutput
- type DetachRolePolicyInput
- type DetachRolePolicyOutput
- type DetachUserPolicyInput
- type DetachUserPolicyOutput
- type DisableOrganizationsRootCredentialsManagementInput
- type DisableOrganizationsRootCredentialsManagementOutput
- type DisableOrganizationsRootSessionsInput
- type DisableOrganizationsRootSessionsOutput
- type EnableMFADeviceInput
- type EnableMFADeviceOutput
- type EnableOrganizationsRootCredentialsManagementInput
- type EnableOrganizationsRootCredentialsManagementOutput
- type EnableOrganizationsRootSessionsInput
- type EnableOrganizationsRootSessionsOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GenerateCredentialReportInput
- type GenerateCredentialReportOutput
- type GenerateOrganizationsAccessReportInput
- type GenerateOrganizationsAccessReportOutput
- type GenerateServiceLastAccessedDetailsInput
- type GenerateServiceLastAccessedDetailsOutput
- type GetAccessKeyLastUsedInput
- type GetAccessKeyLastUsedOutput
- type GetAccountAuthorizationDetailsAPIClient
- type GetAccountAuthorizationDetailsInput
- type GetAccountAuthorizationDetailsOutput
- type GetAccountAuthorizationDetailsPaginator
- type GetAccountAuthorizationDetailsPaginatorOptions
- type GetAccountPasswordPolicyInput
- type GetAccountPasswordPolicyOutput
- type GetAccountSummaryInput
- type GetAccountSummaryOutput
- type GetContextKeysForCustomPolicyInput
- type GetContextKeysForCustomPolicyOutput
- type GetContextKeysForPrincipalPolicyInput
- type GetContextKeysForPrincipalPolicyOutput
- type GetCredentialReportInput
- type GetCredentialReportOutput
- type GetGroupAPIClient
- type GetGroupInput
- type GetGroupOutput
- type GetGroupPaginator
- type GetGroupPaginatorOptions
- type GetGroupPolicyInput
- type GetGroupPolicyOutput
- type GetInstanceProfileAPIClient
- type GetInstanceProfileInput
- type GetInstanceProfileOutput
- type GetLoginProfileInput
- type GetLoginProfileOutput
- type GetMFADeviceInput
- type GetMFADeviceOutput
- type GetOpenIDConnectProviderInput
- type GetOpenIDConnectProviderOutput
- type GetOrganizationsAccessReportInput
- type GetOrganizationsAccessReportOutput
- type GetPolicyAPIClient
- type GetPolicyInput
- type GetPolicyOutput
- type GetPolicyVersionInput
- type GetPolicyVersionOutput
- type GetRoleAPIClient
- type GetRoleInput
- type GetRoleOutput
- type GetRolePolicyInput
- type GetRolePolicyOutput
- type GetSAMLProviderInput
- type GetSAMLProviderOutput
- type GetSSHPublicKeyInput
- type GetSSHPublicKeyOutput
- type GetServerCertificateInput
- type GetServerCertificateOutput
- type GetServiceLastAccessedDetailsInput
- type GetServiceLastAccessedDetailsOutput
- type GetServiceLastAccessedDetailsWithEntitiesInput
- type GetServiceLastAccessedDetailsWithEntitiesOutput
- type GetServiceLinkedRoleDeletionStatusInput
- type GetServiceLinkedRoleDeletionStatusOutput
- type GetUserAPIClient
- type GetUserInput
- type GetUserOutput
- type GetUserPolicyInput
- type GetUserPolicyOutput
- type HTTPClient
- type HTTPSignerV4
- type InstanceProfileExistsWaiter
- func (w *InstanceProfileExistsWaiter) Wait(ctx context.Context, params *GetInstanceProfileInput, maxWaitDur time.Duration, ...) error
- func (w *InstanceProfileExistsWaiter) WaitForOutput(ctx context.Context, params *GetInstanceProfileInput, maxWaitDur time.Duration, ...) (*GetInstanceProfileOutput, error)
- type InstanceProfileExistsWaiterOptions
- type ListAccessKeysAPIClient
- type ListAccessKeysInput
- type ListAccessKeysOutput
- type ListAccessKeysPaginator
- type ListAccessKeysPaginatorOptions
- type ListAccountAliasesAPIClient
- type ListAccountAliasesInput
- type ListAccountAliasesOutput
- type ListAccountAliasesPaginator
- type ListAccountAliasesPaginatorOptions
- type ListAttachedGroupPoliciesAPIClient
- type ListAttachedGroupPoliciesInput
- type ListAttachedGroupPoliciesOutput
- type ListAttachedGroupPoliciesPaginator
- type ListAttachedGroupPoliciesPaginatorOptions
- type ListAttachedRolePoliciesAPIClient
- type ListAttachedRolePoliciesInput
- type ListAttachedRolePoliciesOutput
- type ListAttachedRolePoliciesPaginator
- type ListAttachedRolePoliciesPaginatorOptions
- type ListAttachedUserPoliciesAPIClient
- type ListAttachedUserPoliciesInput
- type ListAttachedUserPoliciesOutput
- type ListAttachedUserPoliciesPaginator
- type ListAttachedUserPoliciesPaginatorOptions
- type ListEntitiesForPolicyAPIClient
- type ListEntitiesForPolicyInput
- type ListEntitiesForPolicyOutput
- type ListEntitiesForPolicyPaginator
- type ListEntitiesForPolicyPaginatorOptions
- type ListGroupPoliciesAPIClient
- type ListGroupPoliciesInput
- type ListGroupPoliciesOutput
- type ListGroupPoliciesPaginator
- type ListGroupPoliciesPaginatorOptions
- type ListGroupsAPIClient
- type ListGroupsForUserAPIClient
- type ListGroupsForUserInput
- type ListGroupsForUserOutput
- type ListGroupsForUserPaginator
- type ListGroupsForUserPaginatorOptions
- type ListGroupsInput
- type ListGroupsOutput
- type ListGroupsPaginator
- type ListGroupsPaginatorOptions
- type ListInstanceProfileTagsAPIClient
- type ListInstanceProfileTagsInput
- type ListInstanceProfileTagsOutput
- type ListInstanceProfileTagsPaginator
- type ListInstanceProfileTagsPaginatorOptions
- type ListInstanceProfilesAPIClient
- type ListInstanceProfilesForRoleAPIClient
- type ListInstanceProfilesForRoleInput
- type ListInstanceProfilesForRoleOutput
- type ListInstanceProfilesForRolePaginator
- type ListInstanceProfilesForRolePaginatorOptions
- type ListInstanceProfilesInput
- type ListInstanceProfilesOutput
- type ListInstanceProfilesPaginator
- type ListInstanceProfilesPaginatorOptions
- type ListMFADeviceTagsAPIClient
- type ListMFADeviceTagsInput
- type ListMFADeviceTagsOutput
- type ListMFADeviceTagsPaginator
- type ListMFADeviceTagsPaginatorOptions
- type ListMFADevicesAPIClient
- type ListMFADevicesInput
- type ListMFADevicesOutput
- type ListMFADevicesPaginator
- type ListMFADevicesPaginatorOptions
- type ListOpenIDConnectProviderTagsAPIClient
- type ListOpenIDConnectProviderTagsInput
- type ListOpenIDConnectProviderTagsOutput
- type ListOpenIDConnectProviderTagsPaginator
- type ListOpenIDConnectProviderTagsPaginatorOptions
- type ListOpenIDConnectProvidersInput
- type ListOpenIDConnectProvidersOutput
- type ListOrganizationsFeaturesInput
- type ListOrganizationsFeaturesOutput
- type ListPoliciesAPIClient
- type ListPoliciesGrantingServiceAccessInput
- type ListPoliciesGrantingServiceAccessOutput
- type ListPoliciesInput
- type ListPoliciesOutput
- type ListPoliciesPaginator
- type ListPoliciesPaginatorOptions
- type ListPolicyTagsAPIClient
- type ListPolicyTagsInput
- type ListPolicyTagsOutput
- type ListPolicyTagsPaginator
- type ListPolicyTagsPaginatorOptions
- type ListPolicyVersionsAPIClient
- type ListPolicyVersionsInput
- type ListPolicyVersionsOutput
- type ListPolicyVersionsPaginator
- type ListPolicyVersionsPaginatorOptions
- type ListRolePoliciesAPIClient
- type ListRolePoliciesInput
- type ListRolePoliciesOutput
- type ListRolePoliciesPaginator
- type ListRolePoliciesPaginatorOptions
- type ListRoleTagsAPIClient
- type ListRoleTagsInput
- type ListRoleTagsOutput
- type ListRoleTagsPaginator
- type ListRoleTagsPaginatorOptions
- type ListRolesAPIClient
- type ListRolesInput
- type ListRolesOutput
- type ListRolesPaginator
- type ListRolesPaginatorOptions
- type ListSAMLProviderTagsAPIClient
- type ListSAMLProviderTagsInput
- type ListSAMLProviderTagsOutput
- type ListSAMLProviderTagsPaginator
- type ListSAMLProviderTagsPaginatorOptions
- type ListSAMLProvidersInput
- type ListSAMLProvidersOutput
- type ListSSHPublicKeysAPIClient
- type ListSSHPublicKeysInput
- type ListSSHPublicKeysOutput
- type ListSSHPublicKeysPaginator
- type ListSSHPublicKeysPaginatorOptions
- type ListServerCertificateTagsAPIClient
- type ListServerCertificateTagsInput
- type ListServerCertificateTagsOutput
- type ListServerCertificateTagsPaginator
- type ListServerCertificateTagsPaginatorOptions
- type ListServerCertificatesAPIClient
- type ListServerCertificatesInput
- type ListServerCertificatesOutput
- type ListServerCertificatesPaginator
- type ListServerCertificatesPaginatorOptions
- type ListServiceSpecificCredentialsInput
- type ListServiceSpecificCredentialsOutput
- type ListSigningCertificatesAPIClient
- type ListSigningCertificatesInput
- type ListSigningCertificatesOutput
- type ListSigningCertificatesPaginator
- type ListSigningCertificatesPaginatorOptions
- type ListUserPoliciesAPIClient
- type ListUserPoliciesInput
- type ListUserPoliciesOutput
- type ListUserPoliciesPaginator
- type ListUserPoliciesPaginatorOptions
- type ListUserTagsAPIClient
- type ListUserTagsInput
- type ListUserTagsOutput
- type ListUserTagsPaginator
- type ListUserTagsPaginatorOptions
- type ListUsersAPIClient
- type ListUsersInput
- type ListUsersOutput
- type ListUsersPaginator
- type ListUsersPaginatorOptions
- type ListVirtualMFADevicesAPIClient
- type ListVirtualMFADevicesInput
- type ListVirtualMFADevicesOutput
- type ListVirtualMFADevicesPaginator
- type ListVirtualMFADevicesPaginatorOptions
- type Options
- type PolicyExistsWaiter
- type PolicyExistsWaiterOptions
- type PutGroupPolicyInput
- type PutGroupPolicyOutput
- type PutRolePermissionsBoundaryInput
- type PutRolePermissionsBoundaryOutput
- type PutRolePolicyInput
- type PutRolePolicyOutput
- type PutUserPermissionsBoundaryInput
- type PutUserPermissionsBoundaryOutput
- type PutUserPolicyInput
- type PutUserPolicyOutput
- type RemoveClientIDFromOpenIDConnectProviderInput
- type RemoveClientIDFromOpenIDConnectProviderOutput
- type RemoveRoleFromInstanceProfileInput
- type RemoveRoleFromInstanceProfileOutput
- type RemoveUserFromGroupInput
- type RemoveUserFromGroupOutput
- type ResetServiceSpecificCredentialInput
- type ResetServiceSpecificCredentialOutput
- type ResolveEndpoint
- type ResyncMFADeviceInput
- type ResyncMFADeviceOutput
- type RoleExistsWaiter
- type RoleExistsWaiterOptions
- type SetDefaultPolicyVersionInput
- type SetDefaultPolicyVersionOutput
- type SetSecurityTokenServicePreferencesInput
- type SetSecurityTokenServicePreferencesOutput
- type SimulateCustomPolicyAPIClient
- type SimulateCustomPolicyInput
- type SimulateCustomPolicyOutput
- type SimulateCustomPolicyPaginator
- type SimulateCustomPolicyPaginatorOptions
- type SimulatePrincipalPolicyAPIClient
- type SimulatePrincipalPolicyInput
- type SimulatePrincipalPolicyOutput
- type SimulatePrincipalPolicyPaginator
- type SimulatePrincipalPolicyPaginatorOptions
- type TagInstanceProfileInput
- type TagInstanceProfileOutput
- type TagMFADeviceInput
- type TagMFADeviceOutput
- type TagOpenIDConnectProviderInput
- type TagOpenIDConnectProviderOutput
- type TagPolicyInput
- type TagPolicyOutput
- type TagRoleInput
- type TagRoleOutput
- type TagSAMLProviderInput
- type TagSAMLProviderOutput
- type TagServerCertificateInput
- type TagServerCertificateOutput
- type TagUserInput
- type TagUserOutput
- type UntagInstanceProfileInput
- type UntagInstanceProfileOutput
- type UntagMFADeviceInput
- type UntagMFADeviceOutput
- type UntagOpenIDConnectProviderInput
- type UntagOpenIDConnectProviderOutput
- type UntagPolicyInput
- type UntagPolicyOutput
- type UntagRoleInput
- type UntagRoleOutput
- type UntagSAMLProviderInput
- type UntagSAMLProviderOutput
- type UntagServerCertificateInput
- type UntagServerCertificateOutput
- type UntagUserInput
- type UntagUserOutput
- type UpdateAccessKeyInput
- type UpdateAccessKeyOutput
- type UpdateAccountPasswordPolicyInput
- type UpdateAccountPasswordPolicyOutput
- type UpdateAssumeRolePolicyInput
- type UpdateAssumeRolePolicyOutput
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateLoginProfileInput
- type UpdateLoginProfileOutput
- type UpdateOpenIDConnectProviderThumbprintInput
- type UpdateOpenIDConnectProviderThumbprintOutput
- type UpdateRoleDescriptionInput
- type UpdateRoleDescriptionOutput
- type UpdateRoleInput
- type UpdateRoleOutput
- type UpdateSAMLProviderInput
- type UpdateSAMLProviderOutput
- type UpdateSSHPublicKeyInput
- type UpdateSSHPublicKeyOutput
- type UpdateServerCertificateInput
- type UpdateServerCertificateOutput
- type UpdateServiceSpecificCredentialInput
- type UpdateServiceSpecificCredentialOutput
- type UpdateSigningCertificateInput
- type UpdateSigningCertificateOutput
- type UpdateUserInput
- type UpdateUserOutput
- type UploadSSHPublicKeyInput
- type UploadSSHPublicKeyOutput
- type UploadServerCertificateInput
- type UploadServerCertificateOutput
- type UploadSigningCertificateInput
- type UploadSigningCertificateOutput
- type UserExistsWaiter
- type UserExistsWaiterOptions
Constants ¶
const ServiceAPIVersion = "2010-05-08"
const ServiceID = "IAM"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.22.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.27.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.27.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddClientIDToOpenIDConnectProviderInput ¶
type AddClientIDToOpenIDConnectProviderInput struct { // The client ID (also known as audience) to add to the IAM OpenID Connect // provider resource. // // This member is required. ClientID *string // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider // resource to add the client ID to. You can get a list of OIDC provider ARNs by // using the ListOpenIDConnectProvidersoperation. // // This member is required. OpenIDConnectProviderArn *string // contains filtered or unexported fields }
type AddClientIDToOpenIDConnectProviderOutput ¶
type AddClientIDToOpenIDConnectProviderOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AddRoleToInstanceProfileInput ¶
type AddRoleToInstanceProfileInput struct { // The name of the instance profile to update. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string // The name of the role to add. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type AddRoleToInstanceProfileOutput ¶
type AddRoleToInstanceProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AddUserToGroupInput ¶
type AddUserToGroupInput struct { // The name of the group to update. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // The name of the user to add. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type AddUserToGroupOutput ¶
type AddUserToGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AttachGroupPolicyInput ¶
type AttachGroupPolicyInput struct { // The name (friendly name, not ARN) of the group to attach the policy to. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // The Amazon Resource Name (ARN) of the IAM policy you want to attach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // contains filtered or unexported fields }
type AttachGroupPolicyOutput ¶
type AttachGroupPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AttachRolePolicyInput ¶
type AttachRolePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to attach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the role to attach the policy to. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type AttachRolePolicyOutput ¶
type AttachRolePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AttachUserPolicyInput ¶
type AttachUserPolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to attach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM user to attach the policy to. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type AttachUserPolicyOutput ¶
type AttachUserPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.27.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.27.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type ChangePasswordInput ¶
type ChangePasswordInput struct { // The new password. The new password must conform to the Amazon Web Services // account's password policy, if one exists. // // The [regex pattern] that is used to validate this parameter is a string of characters. That // string can include almost any printable ASCII character from the space ( \u0020 // ) through the end of the ASCII character range ( \u00FF ). You can also include // the tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) // characters. Any of these characters are valid in a password. However, many // tools, such as the Amazon Web Services Management Console, might restrict the // ability to type certain characters because they have special meaning within that // tool. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. NewPassword *string // The IAM user's current password. // // This member is required. OldPassword *string // contains filtered or unexported fields }
type ChangePasswordOutput ¶
type ChangePasswordOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Identity and Access Management.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddClientIDToOpenIDConnectProvider ¶
func (c *Client) AddClientIDToOpenIDConnectProvider(ctx context.Context, params *AddClientIDToOpenIDConnectProviderInput, optFns ...func(*Options)) (*AddClientIDToOpenIDConnectProviderOutput, error)
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
func (*Client) AddRoleToInstanceProfile ¶
func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleToInstanceProfileInput, optFns ...func(*Options)) (*AddRoleToInstanceProfileOutput, error)
Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.
The caller of this operation must be granted the PassRole permission on the IAM role by a permissions policy.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profilesin the IAM User Guide.
func (*Client) AddUserToGroup ¶
func (c *Client) AddUserToGroup(ctx context.Context, params *AddUserToGroupInput, optFns ...func(*Options)) (*AddUserToGroupOutput, error)
Adds the specified user to the specified group.
func (*Client) AttachGroupPolicy ¶
func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolicyInput, optFns ...func(*Options)) (*AttachGroupPolicyOutput, error)
Attaches the specified managed policy to the specified IAM group.
You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicyPutGroupPolicy .
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) AttachRolePolicy ¶
func (c *Client) AttachRolePolicy(ctx context.Context, params *AttachRolePolicyInput, optFns ...func(*Options)) (*AttachRolePolicyOutput, error)
Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.
You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRoleCreateRole . You can update a role's trust policy using UpdateAssumerolePolicyUpdateAssumerolePolicy .
Use this operation to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicyPutRolePolicy . For more information about policies, see Managed policies and inline policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
func (*Client) AttachUserPolicy ¶
func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyInput, optFns ...func(*Options)) (*AttachUserPolicyOutput, error)
Attaches the specified managed policy to the specified user.
You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicyPutUserPolicy .
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) ChangePassword ¶
func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error)
Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.
Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwordsin the IAM User Guide.
func (*Client) CreateAccessKey ¶
func (c *Client) CreateAccessKey(ctx context.Context, params *CreateAccessKeyInput, optFns ...func(*Options)) (*CreateAccessKeyOutput, error)
Creates a new Amazon Web Services secret access key and corresponding Amazon
Web Services access key ID for the specified user. The default status for new keys is Active .
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.
For information about quotas on the number of keys you can create, see IAM and STS quotas in the IAM User Guide.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.
func (*Client) CreateAccountAlias ¶
func (c *Client) CreateAccountAlias(ctx context.Context, params *CreateAccountAliasInput, optFns ...func(*Options)) (*CreateAccountAliasOutput, error)
Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account aliasin the Amazon Web Services Sign-In User Guide.
func (*Client) CreateGroup ¶
func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
func (*Client) CreateInstanceProfile ¶
func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstanceProfileInput, optFns ...func(*Options)) (*CreateInstanceProfileOutput, error)
Creates a new instance profile. For information about instance profiles, see [Using roles for applications on Amazon EC2]
in the IAM User Guide, and Instance profilesin the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
func (*Client) CreateLoginProfile ¶
func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProfileInput, optFns ...func(*Options)) (*CreateLoginProfileOutput, error)
Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePasswordto update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about managing passwords, see Managing passwords in the IAM User Guide.
func (*Client) CreateOpenIDConnectProvider ¶
func (c *Client) CreateOpenIDConnectProvider(ctx context.Context, params *CreateOpenIDConnectProviderInput, optFns ...func(*Options)) (*CreateOpenIDConnectProviderOutput, error)
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federationin the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvideroperation to highly privileged users.
func (*Client) CreatePolicy ¶
func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error)
Creates a new managed policy for your Amazon Web Services account.
This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policiesin the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.
func (*Client) CreatePolicyVersion ¶
func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error)
Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersionbefore you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
func (*Client) CreateRole ¶
func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns ...func(*Options)) (*CreateRoleOutput, error)
Creates a new role for your Amazon Web Services account.
For more information about roles, see IAM roles in the IAM User Guide. For information about quotas for role names and the number of roles you can create, see IAM and STS quotasin the IAM User Guide.
func (*Client) CreateSAMLProvider ¶
func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProviderInput, optFns ...func(*Options)) (*CreateSAMLProviderOutput, error)
Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.
The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.
When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.
This operation requires Signature Version 4.
For more information, see Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console and About SAML 2.0-based federation in the IAM User Guide.
func (*Client) CreateServiceLinkedRole ¶
func (c *Client) CreateServiceLinkedRole(ctx context.Context, params *CreateServiceLinkedRoleInput, optFns ...func(*Options)) (*CreateServiceLinkedRoleOutput, error)
Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked rolesin the IAM User Guide.
To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.
func (*Client) CreateServiceSpecificCredential ¶
func (c *Client) CreateServiceSpecificCredential(ctx context.Context, params *CreateServiceSpecificCredentialInput, optFns ...func(*Options)) (*CreateServiceSpecificCredentialOutput, error)
Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.
You can have a maximum of two sets of service-specific credentials for each supported service per user.
You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.
For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
Creates a new IAM user for your Amazon Web Services account.
For information about quotas for the number of IAM users you can create, see IAM and STS quotas in the IAM User Guide.
func (*Client) CreateVirtualMFADevice ¶
func (c *Client) CreateVirtualMFADevice(ctx context.Context, params *CreateVirtualMFADeviceInput, optFns ...func(*Options)) (*CreateVirtualMFADeviceOutput, error)
Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use EnableMFADeviceto attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA devicein the IAM User Guide.
For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
func (*Client) DeactivateMFADevice ¶
func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFADeviceInput, optFns ...func(*Options)) (*DeactivateMFADeviceOutput, error)
Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.
For more information about creating and working with virtual MFA devices, see Enabling a virtual multi-factor authentication (MFA) device in the IAM User Guide.
func (*Client) DeleteAccessKey ¶
func (c *Client) DeleteAccessKey(ctx context.Context, params *DeleteAccessKeyInput, optFns ...func(*Options)) (*DeleteAccessKeyOutput, error)
Deletes the access key pair associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
func (*Client) DeleteAccountAlias ¶
func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAliasInput, optFns ...func(*Options)) (*DeleteAccountAliasOutput, error)
Deletes the specified Amazon Web Services account alias. For information about
using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account aliasin the Amazon Web Services Sign-In User Guide.
func (*Client) DeleteAccountPasswordPolicy ¶
func (c *Client) DeleteAccountPasswordPolicy(ctx context.Context, params *DeleteAccountPasswordPolicyInput, optFns ...func(*Options)) (*DeleteAccountPasswordPolicyOutput, error)
Deletes the password policy for the Amazon Web Services account. There are no parameters.
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
Deletes the specified IAM group. The group must not contain any users or have any attached policies.
func (*Client) DeleteGroupPolicy ¶
func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolicyInput, optFns ...func(*Options)) (*DeleteGroupPolicyOutput, error)
Deletes the specified inline policy that is embedded in the specified IAM group.
A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
func (*Client) DeleteInstanceProfile ¶
func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, optFns ...func(*Options)) (*DeleteInstanceProfileOutput, error)
Deletes the specified instance profile. The instance profile must not have an associated role.
Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
For more information about instance profiles, see Using instance profiles in the IAM User Guide.
func (*Client) DeleteLoginProfile ¶
func (c *Client) DeleteLoginProfile(ctx context.Context, params *DeleteLoginProfileInput, optFns ...func(*Options)) (*DeleteLoginProfileOutput, error)
Deletes the password for the specified IAM user, For more information, see Managing passwords for IAM users.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to delete a password for any IAM user. You can use ChangePasswordto update, but not delete, your own password in the My Security Credentials page in the Amazon Web Services Management Console.
Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKeyand DeleteAccessKey.
func (*Client) DeleteOpenIDConnectProvider ¶
func (c *Client) DeleteOpenIDConnectProvider(ctx context.Context, params *DeleteOpenIDConnectProviderInput, optFns ...func(*Options)) (*DeleteOpenIDConnectProviderOutput, error)
Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.
func (*Client) DeletePolicy ¶
func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error)
Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:
Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersionto delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
Delete the policy (this automatically deletes the policy's default version) using this operation.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) DeletePolicyVersion ¶
func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error)
Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.
func (*Client) DeleteRole ¶
func (c *Client) DeleteRole(ctx context.Context, params *DeleteRoleInput, optFns ...func(*Options)) (*DeleteRoleOutput, error)
Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy )
Attached managed policies (DetachRolePolicy )
Instance profile (RemoveRoleFromInstanceProfile )
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile )
Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
func (*Client) DeleteRolePermissionsBoundary ¶
func (c *Client) DeleteRolePermissionsBoundary(ctx context.Context, params *DeleteRolePermissionsBoundaryInput, optFns ...func(*Options)) (*DeleteRolePermissionsBoundaryOutput, error)
Deletes the permissions boundary for the specified IAM role.
You cannot set the boundary for a service-linked role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
func (*Client) DeleteRolePolicy ¶
func (c *Client) DeleteRolePolicy(ctx context.Context, params *DeleteRolePolicyInput, optFns ...func(*Options)) (*DeleteRolePolicyOutput, error)
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
func (*Client) DeleteSAMLProvider ¶
func (c *Client) DeleteSAMLProvider(ctx context.Context, params *DeleteSAMLProviderInput, optFns ...func(*Options)) (*DeleteSAMLProviderOutput, error)
Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
func (*Client) DeleteSSHPublicKey ¶
func (c *Client) DeleteSSHPublicKey(ctx context.Context, params *DeleteSSHPublicKeyInput, optFns ...func(*Options)) (*DeleteSSHPublicKeyOutput, error)
Deletes the specified SSH public key.
The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connectionsin the CodeCommit User Guide.
func (*Client) DeleteServerCertificate ¶
func (c *Client) DeleteServerCertificate(ctx context.Context, params *DeleteServerCertificateInput, optFns ...func(*Options)) (*DeleteServerCertificateOutput, error)
Deletes the specified server certificate.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListenersin the Elastic Load Balancing API Reference.
func (*Client) DeleteServiceLinkedRole ¶
func (c *Client) DeleteServiceLinkedRole(ctx context.Context, params *DeleteServiceLinkedRoleInput, optFns ...func(*Options)) (*DeleteServiceLinkedRoleOutput, error)
Submits a service-linked role deletion request and returns a DeletionTaskId , which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.
If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the Amazon Web Services documentationfor your service.
For more information about service-linked roles, see Roles terms and concepts: Amazon Web Services service-linked role in the IAM User Guide.
func (*Client) DeleteServiceSpecificCredential ¶
func (c *Client) DeleteServiceSpecificCredential(ctx context.Context, params *DeleteServiceSpecificCredentialInput, optFns ...func(*Options)) (*DeleteServiceSpecificCredentialOutput, error)
Deletes the specified service-specific credential.
func (*Client) DeleteSigningCertificate ¶
func (c *Client) DeleteSigningCertificate(ctx context.Context, params *DeleteSigningCertificateInput, optFns ...func(*Options)) (*DeleteSigningCertificateOutput, error)
Deletes a signing certificate associated with the specified IAM user.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated IAM users.
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes the specified IAM user. Unlike the Amazon Web Services Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM user . Before attempting to delete a user, remove the following items:
Password (DeleteLoginProfile )
Access keys (DeleteAccessKey )
Signing certificate (DeleteSigningCertificate )
SSH public key (DeleteSSHPublicKey )
Git credentials (DeleteServiceSpecificCredential )
Multi-factor authentication (MFA) device (DeactivateMFADevice , DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy )
Attached managed policies (DetachUserPolicy )
Group memberships (RemoveUserFromGroup )
func (*Client) DeleteUserPermissionsBoundary ¶
func (c *Client) DeleteUserPermissionsBoundary(ctx context.Context, params *DeleteUserPermissionsBoundaryInput, optFns ...func(*Options)) (*DeleteUserPermissionsBoundaryOutput, error)
Deletes the permissions boundary for the specified IAM user.
Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.
func (*Client) DeleteUserPolicy ¶
func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyInput, optFns ...func(*Options)) (*DeleteUserPolicyOutput, error)
Deletes the specified inline policy that is embedded in the specified IAM user.
A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
func (*Client) DeleteVirtualMFADevice ¶
func (c *Client) DeleteVirtualMFADevice(ctx context.Context, params *DeleteVirtualMFADeviceInput, optFns ...func(*Options)) (*DeleteVirtualMFADeviceOutput, error)
Deletes a virtual MFA device.
You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
func (*Client) DetachGroupPolicy ¶
func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolicyInput, optFns ...func(*Options)) (*DetachGroupPolicyOutput, error)
Removes the specified managed policy from the specified IAM group.
A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) DetachRolePolicy ¶
func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyInput, optFns ...func(*Options)) (*DetachRolePolicyOutput, error)
Removes the specified managed policy from the specified role.
A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) DetachUserPolicy ¶
func (c *Client) DetachUserPolicy(ctx context.Context, params *DetachUserPolicyInput, optFns ...func(*Options)) (*DetachUserPolicyOutput, error)
Removes the specified managed policy from the specified user.
A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) DisableOrganizationsRootCredentialsManagement ¶ added in v1.38.0
func (c *Client) DisableOrganizationsRootCredentialsManagement(ctx context.Context, params *DisableOrganizationsRootCredentialsManagementInput, optFns ...func(*Options)) (*DisableOrganizationsRootCredentialsManagementOutput, error)
Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer manage root user credentials for member accounts in your organization.
func (*Client) DisableOrganizationsRootSessions ¶ added in v1.38.0
func (c *Client) DisableOrganizationsRootSessions(ctx context.Context, params *DisableOrganizationsRootSessionsInput, optFns ...func(*Options)) (*DisableOrganizationsRootSessionsOutput, error)
Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer perform privileged tasks on member accounts in your organization.
func (*Client) EnableMFADevice ¶
func (c *Client) EnableMFADevice(ctx context.Context, params *EnableMFADeviceInput, optFns ...func(*Options)) (*EnableMFADeviceOutput, error)
Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.
func (*Client) EnableOrganizationsRootCredentialsManagement ¶ added in v1.38.0
func (c *Client) EnableOrganizationsRootCredentialsManagement(ctx context.Context, params *EnableOrganizationsRootCredentialsManagementInput, optFns ...func(*Options)) (*EnableOrganizationsRootCredentialsManagementOutput, error)
Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access , the management account and the delegated admininstrator for IAM can manage root user credentials for member accounts in your organization.
Before you enable centralized root access, you must have an account configured with the following settings:
You must manage your Amazon Web Services accounts in Organizations.
Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizationsin the Organizations User Guide.
func (*Client) EnableOrganizationsRootSessions ¶ added in v1.38.0
func (c *Client) EnableOrganizationsRootSessions(ctx context.Context, params *EnableOrganizationsRootSessionsInput, optFns ...func(*Options)) (*EnableOrganizationsRootSessionsOutput, error)
Allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accountsin the Identity and Access Management User Guide.
Before you enable this feature, you must have an account configured with the following settings:
You must manage your Amazon Web Services accounts in Organizations.
Enable trusted access for Identity and Access Management in Organizations. For details, see IAM and Organizationsin the Organizations User Guide.
func (*Client) GenerateCredentialReport ¶
func (c *Client) GenerateCredentialReport(ctx context.Context, params *GenerateCredentialReportInput, optFns ...func(*Options)) (*GenerateCredentialReportOutput, error)
Generates a credential report for the Amazon Web Services account. For more
information about the credential report, see Getting credential reportsin the IAM User Guide.
func (*Client) GenerateOrganizationsAccessReport ¶
func (c *Client) GenerateOrganizationsAccessReport(ctx context.Context, params *GenerateOrganizationsAccessReportInput, optFns ...func(*Options)) (*GenerateOrganizationsAccessReportOutput, error)
Generates a report for service last accessed data for Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.
To call this operation, you must be signed in using your Organizations management account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and Organizations permissions. For more information, see Refining permissions using service last accessed datain the IAM User Guide.
You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.
You can generate a service last accessed data report for a policy by specifying an entity's path and an optional Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.
For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing permissions using service last accessed datain the IAM User Guide.
The data includes all attempts to access Amazon Web Services, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrailin the IAM User Guide.
This operation returns a JobId . Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.
To generate a service last accessed data report for entities, specify an entity path without specifying the optional Organizations policy ID. The type of entity that you specify determines the data returned in the report.
Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the management account, because the management account is not limited by SCPs.
OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the management account, because the management account is not limited by SCPs.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. For each service, the report includes data for only the management account.
Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.
To generate a service last accessed data report for policies, specify an entity path and the optional Organizations policy ID. The type of entity that you specify determines the data returned for each service.
Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.
OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the management account, because the management account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.
management account – When you specify the management account, the resulting report lists all Amazon Web Services services, because the management account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the management account.
Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.
Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating policiesin the IAM User Guide.
For more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
func (*Client) GenerateServiceLastAccessedDetails ¶
func (c *Client) GenerateServiceLastAccessedDetails(ctx context.Context, params *GenerateServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GenerateServiceLastAccessedDetailsOutput, error)
Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access Amazon Web Services services. Recent activity usually appears within four hours. IAM reports activity for at least the last 400 days, or less if your Region began supporting this feature within the last year. For more information, see Regions where data is tracked. For more information about services and actions for which action last accessed information is displayed, see IAM action last accessed information services and actions.
The service last accessed data includes all attempts to access an Amazon Web Services API, not just the successful ones. This includes all attempts that were made using the Amazon Web Services Management Console, the Amazon Web Services API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM events with CloudTrailin the IAM User Guide.
The GenerateServiceLastAccessedDetails operation returns a JobId . Use this parameter in the following operations to retrieve the following details from your report:
GetServiceLastAccessedDetails
- – Use this operation for users, groups, roles, or policies to list every Amazon Web Services service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail must be used by the same
role within a session, or by the same user when used to call GetServiceLastAccessedDetail .
GetServiceLastAccessedDetailsWithEntities
- – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific Amazon Web Services service.
To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.
For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccessoperation.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policiesin the IAM User Guide.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
func (*Client) GetAccessKeyLastUsed ¶
func (c *Client) GetAccessKeyLastUsed(ctx context.Context, params *GetAccessKeyLastUsedInput, optFns ...func(*Options)) (*GetAccessKeyLastUsedOutput, error)
Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the Amazon Web Services service and Region that were specified in the last request made with that key.
func (*Client) GetAccountAuthorizationDetails ¶
func (c *Client) GetAccountAuthorizationDetails(ctx context.Context, params *GetAccountAuthorizationDetailsInput, optFns ...func(*Options)) (*GetAccountAuthorizationDetailsOutput, error)
Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.
func (*Client) GetAccountPasswordPolicy ¶
func (c *Client) GetAccountPasswordPolicy(ctx context.Context, params *GetAccountPasswordPolicyInput, optFns ...func(*Options)) (*GetAccountPasswordPolicyOutput, error)
Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.
func (*Client) GetAccountSummary ¶
func (c *Client) GetAccountSummary(ctx context.Context, params *GetAccountSummaryInput, optFns ...func(*Options)) (*GetAccountSummaryOutput, error)
Retrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account.
For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.
func (*Client) GetContextKeysForCustomPolicy ¶
func (c *Client) GetContextKeysForCustomPolicy(ctx context.Context, params *GetContextKeysForCustomPolicyInput, optFns ...func(*Options)) (*GetContextKeysForCustomPolicyOutput, error)
Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.
func (*Client) GetContextKeysForPrincipalPolicy ¶
func (c *Client) GetContextKeysForPrincipalPolicy(ctx context.Context, params *GetContextKeysForPrincipalPolicyInput, optFns ...func(*Options)) (*GetContextKeysForPrincipalPolicyOutput, error)
Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.
You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicyinstead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicyto understand what key names and values you must supply when you call SimulatePrincipalPolicy.
func (*Client) GetCredentialReport ¶
func (c *Client) GetCredentialReport(ctx context.Context, params *GetCredentialReportInput, optFns ...func(*Options)) (*GetCredentialReportOutput, error)
Retrieves a credential report for the Amazon Web Services account. For more
information about the credential report, see Getting credential reportsin the IAM User Guide.
func (*Client) GetGroup ¶
func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)
Returns a list of IAM users that are in the specified IAM group. You can
paginate the results using the MaxItems and Marker parameters.
func (*Client) GetGroupPolicy ¶
func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput, optFns ...func(*Options)) (*GetGroupPolicyOutput, error)
Retrieves the specified inline policy document that is embedded in the specified IAM group.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicyto determine the policy's default version, then use GetPolicyVersionto retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) GetInstanceProfile ¶
func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProfileInput, optFns ...func(*Options)) (*GetInstanceProfileOutput, error)
Retrieves information about the specified instance profile, including the
instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profilesin the IAM User Guide.
func (*Client) GetLoginProfile ¶
func (c *Client) GetLoginProfile(ctx context.Context, params *GetLoginProfileInput, optFns ...func(*Options)) (*GetLoginProfileOutput, error)
Retrieves the user name for the specified IAM user. A login profile is created when you create a password for the user to access the Amazon Web Services Management Console. If the user does not exist or does not have a password, the operation returns a 404 ( NoSuchEntity ) error.
If you create an IAM user with access to the console, the CreateDate reflects the date you created the initial password for the user.
If you create an IAM user with programmatic access, and then later add a password for the user to access the Amazon Web Services Management Console, the CreateDate reflects the initial password creation date. A user with programmatic access does not have a login profile unless you create a password for the user to access the Amazon Web Services Management Console.
func (*Client) GetMFADevice ¶ added in v1.21.0
func (c *Client) GetMFADevice(ctx context.Context, params *GetMFADeviceInput, optFns ...func(*Options)) (*GetMFADeviceOutput, error)
Retrieves information about an MFA device for a specified user.
func (*Client) GetOpenIDConnectProvider ¶
func (c *Client) GetOpenIDConnectProvider(ctx context.Context, params *GetOpenIDConnectProviderInput, optFns ...func(*Options)) (*GetOpenIDConnectProviderOutput, error)
Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.
func (*Client) GetOrganizationsAccessReport ¶
func (c *Client) GetOrganizationsAccessReport(ctx context.Context, params *GetOrganizationsAccessReportInput, optFns ...func(*Options)) (*GetOrganizationsAccessReportOutput, error)
Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReportoperation. This operation retrieves the status of your report job and the report contents.
Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.
To call this operation, you must be signed in to the management account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining permissions using service last accessed datain the IAM User Guide.
For each service that principals in an account (root user, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.
By default, the list is sorted by service namespace.
func (*Client) GetPolicy ¶
func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error)
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) GetPolicyVersion ¶
func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error)
Retrieves information about the specified version of the specified managed policy, including the policy document.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
To list the available versions for a policy, use ListPolicyVersions.
This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
For more information about the types of policies, see Managed policies and inline policies in the IAM User Guide.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
func (*Client) GetRole ¶
func (c *Client) GetRole(ctx context.Context, params *GetRoleInput, optFns ...func(*Options)) (*GetRoleOutput, error)
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see IAM rolesin the IAM User Guide.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
func (*Client) GetRolePolicy ¶
func (c *Client) GetRolePolicy(ctx context.Context, params *GetRolePolicyInput, optFns ...func(*Options)) (*GetRolePolicyOutput, error)
Retrieves the specified inline policy document that is embedded with the specified IAM role.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicyto determine the policy's default version, then use GetPolicyVersionto retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
For more information about roles, see IAM roles in the IAM User Guide.
func (*Client) GetSAMLProvider ¶
func (c *Client) GetSAMLProvider(ctx context.Context, params *GetSAMLProviderInput, optFns ...func(*Options)) (*GetSAMLProviderOutput, error)
Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.
This operation requires Signature Version 4.
func (*Client) GetSSHPublicKey ¶
func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInput, optFns ...func(*Options)) (*GetSSHPublicKeyOutput, error)
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connectionsin the CodeCommit User Guide.
func (*Client) GetServerCertificate ¶
func (c *Client) GetServerCertificate(ctx context.Context, params *GetServerCertificateInput, optFns ...func(*Options)) (*GetServerCertificateOutput, error)
Retrieves information about the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
func (*Client) GetServiceLastAccessedDetails ¶
func (c *Client) GetServiceLastAccessedDetails(ctx context.Context, params *GetServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GetServiceLastAccessedDetailsOutput, error)
Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of Amazon Web Services services that the resource (user, group, role, or managed policy) can access.
Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policiesin the IAM User Guide.
For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.
The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:
User – Returns the user ARN that you used to generate the report
Group – Returns the ARN of the group member (user) that last attempted to access the service
Role – Returns the role ARN that you used to generate the report
Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service
By default, the list is sorted by service namespace.
If you specified ACTION_LEVEL granularity when you generated the report, this operation returns service and action last accessed data. This includes the most recent access attempt for each tracked action within a service. Otherwise, this operation returns only service data.
For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User Guide.
func (*Client) GetServiceLastAccessedDetailsWithEntities ¶
func (c *Client) GetServiceLastAccessedDetailsWithEntities(ctx context.Context, params *GetServiceLastAccessedDetailsWithEntitiesInput, optFns ...func(*Options)) (*GetServiceLastAccessedDetailsWithEntitiesOutput, error)
After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities . This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.
Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.
Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.
You can also use this operation for user or role reports to retrieve details about those entities.
If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.
By default, the list of associated entities is sorted by date, with the most recent access listed first.
func (*Client) GetServiceLinkedRoleDeletionStatus ¶
func (c *Client) GetServiceLinkedRoleDeletionStatus(ctx context.Context, params *GetServiceLinkedRoleDeletionStatusInput, optFns ...func(*Options)) (*GetServiceLinkedRoleDeletionStatusOutput, error)
Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.
func (*Client) GetUser ¶
func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)
Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.
If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID used to sign the request to this operation.
func (*Client) GetUserPolicy ¶
func (c *Client) GetUserPolicy(ctx context.Context, params *GetUserPolicyInput, optFns ...func(*Options)) (*GetUserPolicyOutput, error)
Retrieves the specified inline policy document that is embedded in the specified IAM user.
Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.
An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicyto determine the policy's default version. Then use GetPolicyVersionto retrieve the policy document.
For more information about policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) ListAccessKeys ¶
func (c *Client) ListAccessKeys(ctx context.Context, params *ListAccessKeysInput, optFns ...func(*Options)) (*ListAccessKeysOutput, error)
Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required.
This operation works for access keys under the Amazon Web Services account. If the Amazon Web Services account has no associated users, the root user returns it's own access key IDs by running this command.
To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation.
func (*Client) ListAccountAliases ¶
func (c *Client) ListAccountAliases(ctx context.Context, params *ListAccountAliasesInput, optFns ...func(*Options)) (*ListAccountAliasesOutput, error)
Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account aliasin the Amazon Web Services Sign-In User Guide.
func (*Client) ListAttachedGroupPolicies ¶
func (c *Client) ListAttachedGroupPolicies(ctx context.Context, params *ListAttachedGroupPoliciesInput, optFns ...func(*Options)) (*ListAttachedGroupPoliciesOutput, error)
Lists all managed policies that are attached to the specified IAM group.
An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use ListGroupPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
func (*Client) ListAttachedRolePolicies ¶
func (c *Client) ListAttachedRolePolicies(ctx context.Context, params *ListAttachedRolePoliciesInput, optFns ...func(*Options)) (*ListAttachedRolePoliciesOutput, error)
Lists all managed policies that are attached to the specified IAM role.
An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use ListRolePolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.
func (*Client) ListAttachedUserPolicies ¶
func (c *Client) ListAttachedUserPolicies(ctx context.Context, params *ListAttachedUserPoliciesInput, optFns ...func(*Options)) (*ListAttachedUserPoliciesOutput, error)
Lists all managed policies that are attached to the specified IAM user.
An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use ListUserPolicies. For information about policies, see Managed policies and inline policies in the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.
func (*Client) ListEntitiesForPolicy ¶
func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntitiesForPolicyInput, optFns ...func(*Options)) (*ListEntitiesForPolicyOutput, error)
Lists all IAM users, groups, and roles that the specified managed policy is attached to.
You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role .
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListGroupPolicies ¶
func (c *Client) ListGroupPolicies(ctx context.Context, params *ListGroupPoliciesInput, optFns ...func(*Options)) (*ListGroupPoliciesOutput, error)
Lists the names of the inline policies that are embedded in the specified IAM group.
An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policiesin the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.
func (*Client) ListGroups ¶
func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
Lists the IAM groups that have the specified path prefix.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListGroupsForUser ¶
func (c *Client) ListGroupsForUser(ctx context.Context, params *ListGroupsForUserInput, optFns ...func(*Options)) (*ListGroupsForUserOutput, error)
Lists the IAM groups that the specified IAM user belongs to.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListInstanceProfileTags ¶ added in v1.2.0
func (c *Client) ListInstanceProfileTags(ctx context.Context, params *ListInstanceProfileTagsInput, optFns ...func(*Options)) (*ListInstanceProfileTagsOutput, error)
Lists the tags that are attached to the specified IAM instance profile. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) ListInstanceProfiles ¶
func (c *Client) ListInstanceProfiles(ctx context.Context, params *ListInstanceProfilesInput, optFns ...func(*Options)) (*ListInstanceProfilesOutput, error)
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see Using instance profilesin the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an instance profile, see GetInstanceProfile.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListInstanceProfilesForRole ¶
func (c *Client) ListInstanceProfilesForRole(ctx context.Context, params *ListInstanceProfilesForRoleInput, optFns ...func(*Options)) (*ListInstanceProfilesForRoleOutput, error)
Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to Using instance profilesin the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListMFADeviceTags ¶ added in v1.2.0
func (c *Client) ListMFADeviceTags(ctx context.Context, params *ListMFADeviceTagsInput, optFns ...func(*Options)) (*ListMFADeviceTagsOutput, error)
Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) ListMFADevices ¶
func (c *Client) ListMFADevices(ctx context.Context, params *ListMFADevicesInput, optFns ...func(*Options)) (*ListMFADevicesOutput, error)
Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request for this operation.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListOpenIDConnectProviderTags ¶ added in v1.2.0
func (c *Client) ListOpenIDConnectProviderTags(ctx context.Context, params *ListOpenIDConnectProviderTagsInput, optFns ...func(*Options)) (*ListOpenIDConnectProviderTagsOutput, error)
Lists the tags that are attached to the specified OpenID Connect (OIDC)-compatible identity provider. The returned list of tags is sorted by tag key. For more information, see About web identity federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
func (*Client) ListOpenIDConnectProviders ¶
func (c *Client) ListOpenIDConnectProviders(ctx context.Context, params *ListOpenIDConnectProvidersInput, optFns ...func(*Options)) (*ListOpenIDConnectProvidersOutput, error)
Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the Amazon Web Services account.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for an OIDC provider, see GetOpenIDConnectProvider.
func (*Client) ListOrganizationsFeatures ¶ added in v1.38.0
func (c *Client) ListOrganizationsFeatures(ctx context.Context, params *ListOrganizationsFeaturesInput, optFns ...func(*Options)) (*ListOrganizationsFeaturesOutput, error)
Lists the centralized root access features enabled for your organization. For more information, see Centrally manage root access for member accounts.
func (*Client) ListPolicies ¶
func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error)
Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.
You can filter the list of policies that is returned using the optional OnlyAttached , Scope , and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to Local . To list only Amazon Web Services managed policies, set Scope to AWS .
You can paginate the results using the MaxItems and Marker parameters.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.
func (*Client) ListPoliciesGrantingServiceAccess ¶
func (c *Client) ListPoliciesGrantingServiceAccess(ctx context.Context, params *ListPoliciesGrantingServiceAccessInput, optFns ...func(*Options)) (*ListPoliciesGrantingServiceAccessOutput, error)
Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.
This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, Organizations policies, IAM permissions boundaries, and STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating policiesin the IAM User Guide.
The list of policies returned by the operation depends on the ARN of the identity that you provide.
User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.
Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.
Role – The list of policies includes only the managed and inline policies that are attached to the role.
For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed policies and inline policiesin the IAM User Guide.
Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUseror GetRole operations.
func (*Client) ListPolicyTags ¶ added in v1.2.0
func (c *Client) ListPolicyTags(ctx context.Context, params *ListPolicyTagsInput, optFns ...func(*Options)) (*ListPolicyTagsOutput, error)
Lists the tags that are attached to the specified IAM customer managed policy. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) ListPolicyVersions ¶
func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error)
Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) ListRolePolicies ¶
func (c *Client) ListRolePolicies(ctx context.Context, params *ListRolePoliciesInput, optFns ...func(*Options)) (*ListRolePoliciesOutput, error)
Lists the names of the inline policies that are embedded in the specified IAM role.
An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policiesin the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.
func (*Client) ListRoleTags ¶
func (c *Client) ListRoleTags(ctx context.Context, params *ListRoleTagsInput, optFns ...func(*Options)) (*ListRoleTagsOutput, error)
Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) ListRoles ¶
func (c *Client) ListRoles(ctx context.Context, params *ListRolesInput, optFns ...func(*Options)) (*ListRolesOutput, error)
Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see IAM rolesin the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
RoleLastUsed
Tags
To view all of the information for a role, see GetRole.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListSAMLProviderTags ¶ added in v1.2.0
func (c *Client) ListSAMLProviderTags(ctx context.Context, params *ListSAMLProviderTagsInput, optFns ...func(*Options)) (*ListSAMLProviderTagsOutput, error)
Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.
For more information about tagging, see Tagging IAM resources in the IAM User Guide.
func (*Client) ListSAMLProviders ¶
func (c *Client) ListSAMLProviders(ctx context.Context, params *ListSAMLProvidersInput, optFns ...func(*Options)) (*ListSAMLProvidersOutput, error)
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
This operation requires Signature Version 4.
func (*Client) ListSSHPublicKeys ¶
func (c *Client) ListSSHPublicKeys(ctx context.Context, params *ListSSHPublicKeysInput, optFns ...func(*Options)) (*ListSSHPublicKeysOutput, error)
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.
The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connectionsin the CodeCommit User Guide.
Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
func (*Client) ListServerCertificateTags ¶ added in v1.2.0
func (c *Client) ListServerCertificateTags(ctx context.Context, params *ListServerCertificateTagsInput, optFns ...func(*Options)) (*ListServerCertificateTagsOutput, error)
Lists the tags that are attached to the specified IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificatesin the IAM User Guide.
func (*Client) ListServerCertificates ¶
func (c *Client) ListServerCertificates(ctx context.Context, params *ListServerCertificatesInput, optFns ...func(*Options)) (*ListServerCertificatesOutput, error)
Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.
You can paginate the results using the MaxItems and Marker parameters.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.
func (*Client) ListServiceSpecificCredentials ¶
func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *ListServiceSpecificCredentialsInput, optFns ...func(*Options)) (*ListServiceSpecificCredentialsOutput, error)
Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an Amazon Web Services service, see Set up service-specific credentialsin the CodeCommit User Guide.
func (*Client) ListSigningCertificates ¶
func (c *Client) ListSigningCertificates(ctx context.Context, params *ListSigningCertificatesInput, optFns ...func(*Options)) (*ListSigningCertificatesOutput, error)
Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.
Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request for this operation. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
func (*Client) ListUserPolicies ¶
func (c *Client) ListUserPolicies(ctx context.Context, params *ListUserPoliciesInput, optFns ...func(*Options)) (*ListUserPoliciesOutput, error)
Lists the names of the inline policies embedded in the specified IAM user.
An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policiesin the IAM User Guide.
You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.
func (*Client) ListUserTags ¶
func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, optFns ...func(*Options)) (*ListUserTagsOutput, error)
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 resourcesin the IAM User Guide.
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the Amazon Web Services account. If there are none, the operation returns an empty list.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
PermissionsBoundary
Tags
To view all of the information for a user, see GetUser.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) ListVirtualMFADevices ¶
func (c *Client) ListVirtualMFADevices(ctx context.Context, params *ListVirtualMFADevicesInput, optFns ...func(*Options)) (*ListVirtualMFADevicesOutput, error)
Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned , Unassigned , or Any .
IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.
You can paginate the results using the MaxItems and Marker parameters.
func (*Client) Options ¶ added in v1.28.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PutGroupPolicy ¶
func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput, optFns ...func(*Options)) (*PutGroupPolicyOutput, error)
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicyAttachGroupPolicy . To create a new managed policy, use CreatePolicy CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotasin the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy . For general information about using the Query API with IAM, see Making query requestsin the IAM User Guide.
func (*Client) PutRolePermissionsBoundary ¶
func (c *Client) PutRolePermissionsBoundary(ctx context.Context, params *PutRolePermissionsBoundaryInput, optFns ...func(*Options)) (*PutRolePermissionsBoundaryOutput, error)
Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.
You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logicin the IAM User Guide.
func (*Client) PutRolePolicy ¶
func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, optFns ...func(*Options)) (*PutRolePolicyOutput, error)
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRoleCreateRole . You can update a role's trust policy using UpdateAssumeRolePolicyUpdateAssumeRolePolicy . For more information about roles, see IAM roles in the IAM User Guide.
A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicyAttachRolePolicy . To create a new managed policy, use CreatePolicy CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotasin the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy . For general information about using the Query API with IAM, see Making query requestsin the IAM User Guide.
func (*Client) PutUserPermissionsBoundary ¶
func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUserPermissionsBoundaryInput, optFns ...func(*Options)) (*PutUserPermissionsBoundaryOutput, error)
Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an Amazon Web Services managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.
Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON policy evaluation logicin the IAM User Guide.
func (*Client) PutUserPolicy ¶
func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, optFns ...func(*Options)) (*PutUserPolicyOutput, error)
Adds or updates an inline policy document that is embedded in the specified IAM user.
An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicyAttachUserPolicy . To create a new managed policy, use CreatePolicy CreatePolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotasin the IAM User Guide.
Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy . For general information about using the Query API with IAM, see Making query requestsin the IAM User Guide.
func (*Client) RemoveClientIDFromOpenIDConnectProvider ¶
func (c *Client) RemoveClientIDFromOpenIDConnectProvider(ctx context.Context, params *RemoveClientIDFromOpenIDConnectProviderInput, optFns ...func(*Options)) (*RemoveClientIDFromOpenIDConnectProviderOutput, error)
Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.
This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.
func (*Client) RemoveRoleFromInstanceProfile ¶
func (c *Client) RemoveRoleFromInstanceProfile(ctx context.Context, params *RemoveRoleFromInstanceProfileInput, optFns ...func(*Options)) (*RemoveRoleFromInstanceProfileOutput, error)
Removes the specified IAM role from the specified Amazon EC2 instance profile.
Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.
For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profilesin the IAM User Guide.
func (*Client) RemoveUserFromGroup ¶
func (c *Client) RemoveUserFromGroup(ctx context.Context, params *RemoveUserFromGroupInput, optFns ...func(*Options)) (*RemoveUserFromGroupOutput, error)
Removes the specified user from the specified group.
func (*Client) ResetServiceSpecificCredential ¶
func (c *Client) ResetServiceSpecificCredential(ctx context.Context, params *ResetServiceSpecificCredentialInput, optFns ...func(*Options)) (*ResetServiceSpecificCredentialOutput, error)
Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.
func (*Client) ResyncMFADevice ¶
func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInput, optFns ...func(*Options)) (*ResyncMFADeviceOutput, error)
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
func (*Client) SetDefaultPolicyVersion ¶
func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error)
Sets the specified version of the specified policy as the policy's default (operative) version.
This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
func (*Client) SetSecurityTokenServicePreferences ¶
func (c *Client) SetSecurityTokenServicePreferences(ctx context.Context, params *SetSecurityTokenServicePreferencesInput, optFns ...func(*Options)) (*SetSecurityTokenServicePreferencesOutput, error)
Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com . Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotasin the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Regionin the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummaryoperation.
func (*Client) SimulateCustomPolicy ¶
func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCustomPolicyInput, optFns ...func(*Options)) (*SimulateCustomPolicyOutput, error)
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicyinstead.
Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulatorin the IAM User Guide.
func (*Client) SimulatePrincipalPolicy ¶
func (c *Client) SimulatePrincipalPolicy(ctx context.Context, params *SimulatePrincipalPolicyInput, optFns ...func(*Options)) (*SimulatePrincipalPolicyOutput, error)
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicyinstead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicyinstead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems and Marker parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulatorin the IAM User Guide.
func (*Client) TagInstanceProfile ¶ added in v1.2.0
func (c *Client) TagInstanceProfile(ctx context.Context, params *TagInstanceProfileInput, optFns ...func(*Options)) (*TagInstanceProfileOutput, error)
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagMFADevice ¶ added in v1.2.0
func (c *Client) TagMFADevice(ctx context.Context, params *TagMFADeviceInput, optFns ...func(*Options)) (*TagMFADeviceOutput, error)
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagOpenIDConnectProvider ¶ added in v1.2.0
func (c *Client) TagOpenIDConnectProvider(ctx context.Context, params *TagOpenIDConnectProviderInput, optFns ...func(*Options)) (*TagOpenIDConnectProviderOutput, error)
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagPolicy ¶ added in v1.2.0
func (c *Client) TagPolicy(ctx context.Context, params *TagPolicyInput, optFns ...func(*Options)) (*TagPolicyOutput, error)
Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagRole ¶
func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...func(*Options)) (*TagRoleOutput, error)
Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
func (*Client) TagSAMLProvider ¶ added in v1.2.0
func (c *Client) TagSAMLProvider(ctx context.Context, params *TagSAMLProviderInput, optFns ...func(*Options)) (*TagSAMLProviderOutput, error)
Adds one or more tags to a Security Assertion Markup Language (SAML) identity provider. For more information about these providers, see About SAML 2.0-based federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a SAML identity provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagServerCertificate ¶ added in v1.2.0
func (c *Client) TagServerCertificate(ctx context.Context, params *TagServerCertificateInput, optFns ...func(*Options)) (*TagServerCertificateOutput, error)
Adds one or more tags to an IAM server certificate. If a tag with the same key name already exists, then that tag is overwritten with the new value.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificatesin the IAM User Guide.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only a server certificate that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
func (*Client) TagUser ¶
func (c *Client) TagUser(ctx context.Context, params *TagUserInput, optFns ...func(*Options)) (*TagUserOutput, error)
Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM identity-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tagsin the IAM User Guide.
Cost allocation - Use tags to help track which individuals and teams are using which Amazon Web Services resources.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
For more information about tagging, see Tagging IAM identities in the IAM User Guide.
func (*Client) UntagInstanceProfile ¶ added in v1.2.0
func (c *Client) UntagInstanceProfile(ctx context.Context, params *UntagInstanceProfileInput, optFns ...func(*Options)) (*UntagInstanceProfileOutput, error)
Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UntagMFADevice ¶ added in v1.2.0
func (c *Client) UntagMFADevice(ctx context.Context, params *UntagMFADeviceInput, optFns ...func(*Options)) (*UntagMFADeviceOutput, error)
Removes the specified tags from the IAM virtual multi-factor authentication (MFA) device. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UntagOpenIDConnectProvider ¶ added in v1.2.0
func (c *Client) UntagOpenIDConnectProvider(ctx context.Context, params *UntagOpenIDConnectProviderInput, optFns ...func(*Options)) (*UntagOpenIDConnectProviderOutput, error)
Removes the specified tags from the specified OpenID Connect (OIDC)-compatible identity provider in IAM. For more information about OIDC providers, see About web identity federation. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UntagPolicy ¶ added in v1.2.0
func (c *Client) UntagPolicy(ctx context.Context, params *UntagPolicyInput, optFns ...func(*Options)) (*UntagPolicyOutput, error)
Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UntagRole ¶
func (c *Client) UntagRole(ctx context.Context, params *UntagRoleInput, optFns ...func(*Options)) (*UntagRoleOutput, error)
Removes the specified tags from the role. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UntagSAMLProvider ¶ added in v1.2.0
func (c *Client) UntagSAMLProvider(ctx context.Context, params *UntagSAMLProviderInput, optFns ...func(*Options)) (*UntagSAMLProviderOutput, error)
Removes the specified tags from the specified Security Assertion Markup Language (SAML) identity provider in IAM. For more information about these providers, see About web identity federation. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
func (*Client) UntagServerCertificate ¶ added in v1.2.0
func (c *Client) UntagServerCertificate(ctx context.Context, params *UntagServerCertificateInput, optFns ...func(*Options)) (*UntagServerCertificateOutput, error)
Removes the specified tags from the IAM server certificate. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
For certificates in a Region supported by Certificate Manager (ACM), we recommend that you don't use IAM server certificates. Instead, use ACM to provision, manage, and deploy your server certificates. For more information about IAM server certificates, Working with server certificatesin the IAM User Guide.
func (*Client) UntagUser ¶
func (c *Client) UntagUser(ctx context.Context, params *UntagUserInput, optFns ...func(*Options)) (*UntagUserOutput, error)
Removes the specified tags from the user. For more information about tagging, see Tagging IAM resourcesin the IAM User Guide.
func (*Client) UpdateAccessKey ¶
func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInput, optFns ...func(*Options)) (*UpdateAccessKeyOutput, error)
Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.
If the UserName is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. If a temporary access key is used, then UserName is required. If a long-term key is assigned to the user, then UserName is not required. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
For information about rotating keys, see Managing keys and certificates in the IAM User Guide.
func (*Client) UpdateAccountPasswordPolicy ¶
func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *UpdateAccountPasswordPolicyInput, optFns ...func(*Options)) (*UpdateAccountPasswordPolicyOutput, error)
Updates the password policy settings for the Amazon Web Services account.
This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
func (*Client) UpdateAssumeRolePolicy ¶
func (c *Client) UpdateAssumeRolePolicy(ctx context.Context, params *UpdateAssumeRolePolicyInput, optFns ...func(*Options)) (*UpdateAssumeRolePolicyOutput, error)
Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the "role trust policy". For more information about roles, see Using roles to delegate permissions and federate identities.
func (*Client) UpdateGroup ¶
func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)
Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groupsin the IAM User Guide.
The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs , the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access management.
func (*Client) UpdateLoginProfile ¶
func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProfileInput, optFns ...func(*Options)) (*UpdateLoginProfileOutput, error)
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePasswordto change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about modifying passwords, see Managing passwords in the IAM User Guide.
func (*Client) UpdateOpenIDConnectProviderThumbprint ¶
func (c *Client) UpdateOpenIDConnectProviderThumbprint(ctx context.Context, params *UpdateOpenIDConnectProviderThumbprintInput, optFns ...func(*Options)) (*UpdateOpenIDConnectProviderThumbprintOutput, error)
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
func (*Client) UpdateRole ¶
func (c *Client) UpdateRole(ctx context.Context, params *UpdateRoleInput, optFns ...func(*Options)) (*UpdateRoleOutput, error)
Updates the description or maximum session duration setting of a role.
func (*Client) UpdateRoleDescription ¶
func (c *Client) UpdateRoleDescription(ctx context.Context, params *UpdateRoleDescriptionInput, optFns ...func(*Options)) (*UpdateRoleDescriptionOutput, error)
Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.
func (*Client) UpdateSAMLProvider ¶
func (c *Client) UpdateSAMLProvider(ctx context.Context, params *UpdateSAMLProviderInput, optFns ...func(*Options)) (*UpdateSAMLProviderOutput, error)
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
func (*Client) UpdateSSHPublicKey ¶
func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublicKeyInput, optFns ...func(*Options)) (*UpdateSSHPublicKeyOutput, error)
Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.
The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connectionsin the CodeCommit User Guide.
func (*Client) UpdateServerCertificate ¶
func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServerCertificateInput, optFns ...func(*Options)) (*UpdateServerCertificateOutput, error)
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificatein the IAM User Guide.
The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert , the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access management in the IAM User Guide.
func (*Client) UpdateServiceSpecificCredential ¶
func (c *Client) UpdateServiceSpecificCredential(ctx context.Context, params *UpdateServiceSpecificCredentialInput, optFns ...func(*Options)) (*UpdateServiceSpecificCredentialOutput, error)
Sets the status of a service-specific credential to Active or Inactive . Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.
func (*Client) UpdateSigningCertificate ¶
func (c *Client) UpdateSigningCertificate(ctx context.Context, params *UpdateSigningCertificateInput, optFns ...func(*Options)) (*UpdateSigningCertificateOutput, error)
Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.
If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
Updates the name and/or the path of the specified IAM user.
You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM userand Renaming an IAM group in the IAM User Guide.
To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and policies.
func (*Client) UploadSSHPublicKey ¶
func (c *Client) UploadSSHPublicKey(ctx context.Context, params *UploadSSHPublicKeyInput, optFns ...func(*Options)) (*UploadSSHPublicKeyOutput, error)
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connectionsin the CodeCommit User Guide.
func (*Client) UploadServerCertificate ¶
func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServerCertificateInput, optFns ...func(*Options)) (*UploadServerCertificateOutput, error)
Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.
For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.
Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate . For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requestsin the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Calling the API by making HTTP query requestsin the IAM User Guide.
func (*Client) UploadSigningCertificate ¶
func (c *Client) UploadSigningCertificate(ctx context.Context, params *UploadSigningCertificateInput, optFns ...func(*Options)) (*UploadSigningCertificateOutput, error)
Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active .
For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.
If the UserName is not specified, the IAM user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.
Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate . For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requestsin the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requestsin the IAM User Guide.
type CreateAccessKeyInput ¶
type CreateAccessKeyInput struct { // The name of the IAM user that the new key will belong to. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type CreateAccessKeyOutput ¶
type CreateAccessKeyOutput struct { // A structure with details about the access key. // // This member is required. AccessKey *types.AccessKey // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateAccessKey request.
type CreateAccountAliasInput ¶
type CreateAccountAliasInput struct { // The account alias to create. // // This parameter allows (through its [regex pattern]) a string of characters consisting of // lowercase letters, digits, and dashes. You cannot start or finish with a dash, // nor can you have two dashes in a row. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountAlias *string // contains filtered or unexported fields }
type CreateAccountAliasOutput ¶
type CreateAccountAliasOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateGroupInput ¶
type CreateGroupInput struct { // The name of the group to create. Do not include the path in this value. // // IAM user, group, role, and policy names must be unique within the account. // Names are not distinguished by case. For example, you cannot create resources // named both "MyResource" and "myresource". // // This member is required. GroupName *string // The path to the group. For more information about paths, see [IAM identifiers] in the IAM User // Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // [regex pattern]: http://wikipedia.org/wiki/regex Path *string // contains filtered or unexported fields }
type CreateGroupOutput ¶
type CreateGroupOutput struct { // A structure containing details about the new group. // // This member is required. Group *types.Group // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateGroup request.
type CreateInstanceProfileInput ¶
type CreateInstanceProfileInput struct { // The name of the instance profile to create. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string // The path to the instance profile. For more information about paths, see [IAM Identifiers] in // the IAM User Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // [regex pattern]: http://wikipedia.org/wiki/regex // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html Path *string // A list of tags that you want to attach to the newly created IAM instance // profile. Each tag consists of a key name and an associated value. For more // information about tagging, see [Tagging IAM resources]in the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreateInstanceProfileOutput ¶
type CreateInstanceProfileOutput struct { // A structure containing details about the new instance profile. // // This member is required. InstanceProfile *types.InstanceProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateInstanceProfile request.
type CreateLoginProfileInput ¶
type CreateLoginProfileInput struct { // The new password for the user. // // This parameter must be omitted when you make the request with an [AssumeRoot] session. It // is required in all other cases. // // The [regex pattern] that is used to validate this parameter is a string of characters. That // string can include almost any printable ASCII character from the space ( \u0020 // ) through the end of the ASCII character range ( \u00FF ). You can also include // the tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D ) // characters. Any of these characters are valid in a password. However, many // tools, such as the Amazon Web Services Management Console, might restrict the // ability to type certain characters because they have special meaning within that // tool. // // [AssumeRoot]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html // [regex pattern]: http://wikipedia.org/wiki/regex Password *string // Specifies whether the user is required to set a new password on next sign-in. PasswordResetRequired bool // The name of the IAM user to create a password for. The user must already exist. // // This parameter is optional. If no user name is included, it defaults to the // principal making the request. When you make this request with root user // credentials, you must use an [AssumeRoot]session to omit the user name. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [AssumeRoot]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type CreateLoginProfileOutput ¶
type CreateLoginProfileOutput struct { // A structure containing the user name and password create date. // // This member is required. LoginProfile *types.LoginProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateLoginProfile request.
type CreateOpenIDConnectProviderInput ¶
type CreateOpenIDConnectProviderInput struct { // The URL of the identity provider. The URL must begin with https:// and should // correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the // OIDC standard, path components are allowed but query parameters are not. // Typically the URL consists of only a hostname, like https://server.example.org // or https://example.com . The URL should not contain a port number. // // You cannot register the same provider multiple times in a single Amazon Web // Services account. If you try to submit a URL that has already been used for an // OpenID Connect provider in the Amazon Web Services account, you will get an // error. // // This member is required. Url *string // Provides a list of client IDs, also known as audiences. When a mobile or web // app registers with an OpenID Connect provider, they establish a value that // identifies the application. This is the value that's sent as the client_id // parameter on OAuth requests. // // You can register multiple client IDs with the same provider. For example, you // might have multiple applications that use the same OIDC provider. You cannot // register more than 100 client IDs with a single IAM OIDC provider. // // There is no defined format for a client ID. The // CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 // characters long. ClientIDList []string // A list of tags that you want to attach to the new IAM OpenID Connect (OIDC) // provider. Each tag consists of a key name and an associated value. For more // information about tagging, see [Tagging IAM resources]in the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // A list of server certificate thumbprints for the OpenID Connect (OIDC) identity // provider's server certificates. Typically this list includes only one entry. // However, IAM lets you have up to five thumbprints for an OIDC provider. This // lets you maintain multiple thumbprints if the identity provider is rotating // certificates. // // This parameter is optional. If it is not included, IAM will retrieve and use // the top intermediate certificate authority (CA) thumbprint of the OpenID Connect // identity provider server certificate. // // The server certificate thumbprint is the hex-encoded SHA-1 hash value of the // X.509 certificate used by the domain where the OpenID Connect provider makes its // keys available. It is always a 40-character string. // // For example, assume that the OIDC provider is server.example.com and the // provider stores its keys at https://keys.server.example.com/openid-connect. In // that case, the thumbprint string would be the hex-encoded SHA-1 hash value of // the certificate used by https://keys.server.example.com. // // For more information about obtaining the OIDC provider thumbprint, see [Obtaining the thumbprint for an OpenID Connect provider] in the // IAM user Guide. // // [Obtaining the thumbprint for an OpenID Connect provider]: https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html ThumbprintList []string // contains filtered or unexported fields }
type CreateOpenIDConnectProviderOutput ¶
type CreateOpenIDConnectProviderOutput struct { // The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is // created. For more information, see OpenIDConnectProviderListEntry. OpenIDConnectProviderArn *string // A list of tags that are attached to the new IAM OIDC provider. The returned // list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in // the IAM User Guide. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateOpenIDConnectProvider request.
type CreatePolicyInput ¶
type CreatePolicyInput struct { // The JSON policy document that you want to use as the content for the new policy. // // You must provide policies in JSON format in IAM. However, for CloudFormation // templates formatted in YAML, you can provide the policy in JSON or YAML format. // CloudFormation always converts a YAML policy to JSON format before submitting it // to IAM. // // The maximum length of the policy document that you can pass in this operation, // including whitespace, is listed below. To view the maximum character counts of a // managed policy with no whitespaces, see [IAM and STS character quotas]. // // To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language] in the IAM User Guide. // // The [regex pattern] used to validate this parameter is a string of characters consisting of // the following: // // - Any printable ASCII character ranging from the space character ( \u0020 ) // through the end of the ASCII character range // // - The printable characters in the Basic Latin and Latin-1 Supplement // character set (through \u00FF ) // // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage // return ( \u000D ) // // [Grammar of the IAM JSON policy language]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html // [regex pattern]: http://wikipedia.org/wiki/regex // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length // // This member is required. PolicyDocument *string // The friendly name of the policy. // // IAM user, group, role, and policy names must be unique within the account. // Names are not distinguished by case. For example, you cannot create resources // named both "MyResource" and "myresource". // // This member is required. PolicyName *string // A friendly description of the policy. // // Typically used to store information about the permissions defined in the // policy. For example, "Grants access to production DynamoDB tables." // // The policy description is immutable. After a value is assigned, it cannot be // changed. Description *string // The path for the policy. // // For more information about paths, see [IAM identifiers] in the IAM User Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // You cannot use an asterisk (*) in the path name. // // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // [regex pattern]: http://wikipedia.org/wiki/regex Path *string // A list of tags that you want to attach to the new IAM customer managed policy. // Each tag consists of a key name and an associated value. For more information // about tagging, see [Tagging IAM resources]in the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreatePolicyOutput ¶
type CreatePolicyOutput struct { // A structure containing details about the new policy. Policy *types.Policy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreatePolicy request.
type CreatePolicyVersionInput ¶
type CreatePolicyVersionInput struct { // The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new // version. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The JSON policy document that you want to use as the content for this new // version of the policy. // // You must provide policies in JSON format in IAM. However, for CloudFormation // templates formatted in YAML, you can provide the policy in JSON or YAML format. // CloudFormation always converts a YAML policy to JSON format before submitting it // to IAM. // // The maximum length of the policy document that you can pass in this operation, // including whitespace, is listed below. To view the maximum character counts of a // managed policy with no whitespaces, see [IAM and STS character quotas]. // // The [regex pattern] used to validate this parameter is a string of characters consisting of // the following: // // - Any printable ASCII character ranging from the space character ( \u0020 ) // through the end of the ASCII character range // // - The printable characters in the Basic Latin and Latin-1 Supplement // character set (through \u00FF ) // // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage // return ( \u000D ) // // [regex pattern]: http://wikipedia.org/wiki/regex // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length // // This member is required. PolicyDocument *string // Specifies whether to set this version as the policy's default version. // // When this parameter is true , the new policy version becomes the operative // version. That is, it becomes the version that is in effect for the IAM users, // groups, and roles that the policy is attached to. // // For more information about managed policy versions, see [Versioning for managed policies] in the IAM User Guide. // // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html SetAsDefault bool // contains filtered or unexported fields }
type CreatePolicyVersionOutput ¶
type CreatePolicyVersionOutput struct { // A structure containing details about the new policy version. PolicyVersion *types.PolicyVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreatePolicyVersion request.
type CreateRoleInput ¶
type CreateRoleInput struct { // The trust relationship policy document that grants an entity permission to // assume the role. // // In IAM, you must provide a JSON policy that has been converted to a string. // However, for CloudFormation templates formatted in YAML, you can provide the // policy in JSON or YAML format. CloudFormation always converts a YAML policy to // JSON format before submitting it to IAM. // // The [regex pattern] used to validate this parameter is a string of characters consisting of // the following: // // - Any printable ASCII character ranging from the space character ( \u0020 ) // through the end of the ASCII character range // // - The printable characters in the Basic Latin and Latin-1 Supplement // character set (through \u00FF ) // // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage // return ( \u000D ) // // Upon success, the response includes the same trust policy in JSON format. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AssumeRolePolicyDocument *string // The name of the role to create. // // IAM user, group, role, and policy names must be unique within the account. // Names are not distinguished by case. For example, you cannot create resources // named both "MyResource" and "myresource". // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // A description of the role. Description *string // The maximum session duration (in seconds) that you want to set for the // specified role. If you do not specify a value for this setting, the default // value of one hour is applied. This setting can have a value from 1 hour to 12 // hours. // // Anyone who assumes the role from the CLI or API can use the DurationSeconds API // parameter or the duration-seconds CLI parameter to request a longer session. // The MaxSessionDuration setting determines the maximum duration that can be // requested using the DurationSeconds parameter. If users don't specify a value // for the DurationSeconds parameter, their security credentials are valid for one // hour by default. This applies when you use the AssumeRole* API operations or // the assume-role* CLI operations but does not apply when you use those // operations to create a console URL. For more information, see [Using IAM roles]in the IAM User // Guide. // // [Using IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html MaxSessionDuration *int32 // The path to the role. For more information about paths, see [IAM Identifiers] in the IAM User // Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // [regex pattern]: http://wikipedia.org/wiki/regex // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html Path *string // The ARN of the managed policy that is used to set the permissions boundary for // the role. // // A permissions boundary policy defines the maximum permissions that // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM // User Guide. // // For more information about policy types, see [Policy types] in the IAM User Guide. // // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html PermissionsBoundary *string // A list of tags that you want to attach to the new role. Each tag consists of a // key name and an associated value. For more information about tagging, see [Tagging IAM resources]in // the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreateRoleOutput ¶
type CreateRoleOutput struct { // A structure containing details about the new role. // // This member is required. Role *types.Role // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateRole request.
type CreateSAMLProviderInput ¶
type CreateSAMLProviderInput struct { // The name of the provider to create. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. Name *string // An XML document generated by an identity provider (IdP) that supports SAML 2.0. // The document includes the issuer's name, expiration information, and keys that // can be used to validate the SAML authentication response (assertions) that are // received from the IdP. You must generate the metadata document using the // identity management software that is used as your organization's IdP. // // For more information, see [About SAML 2.0-based federation] in the IAM User Guide // // [About SAML 2.0-based federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html // // This member is required. SAMLMetadataDocument *string // A list of tags that you want to attach to the new IAM SAML provider. Each tag // consists of a key name and an associated value. For more information about // tagging, see [Tagging IAM resources]in the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreateSAMLProviderOutput ¶
type CreateSAMLProviderOutput struct { // The Amazon Resource Name (ARN) of the new SAML provider resource in IAM. SAMLProviderArn *string // A list of tags that are attached to the new IAM SAML provider. The returned // list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in // the IAM User Guide. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateSAMLProvider request.
type CreateServiceLinkedRoleInput ¶
type CreateServiceLinkedRoleInput struct { // The service principal for the Amazon Web Services service to which this role is // attached. You use a string similar to a URL but without the http:// in front. // For example: elasticbeanstalk.amazonaws.com . // // Service principals are unique and case-sensitive. To find the exact service // principal for your service-linked role, see [Amazon Web Services services that work with IAM]in the IAM User Guide. Look for the // services that have Yes in the Service-Linked Role column. Choose the Yes link to // view the service-linked role documentation for that service. // // [Amazon Web Services services that work with IAM]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html // // This member is required. AWSServiceName *string // A string that you provide, which is combined with the service-provided prefix // to form the complete role name. If you make multiple requests for the same // service, then you must supply a different CustomSuffix for each request. // Otherwise the request fails with a duplicate role name error. For example, you // could add -1 or -debug to the suffix. // // Some services do not support the CustomSuffix parameter. If you provide an // optional suffix and the operation fails, try the operation again without the // suffix. CustomSuffix *string // The description of the role. Description *string // contains filtered or unexported fields }
type CreateServiceLinkedRoleOutput ¶
type CreateServiceLinkedRoleOutput struct { // A Role object that contains details about the newly created role. Role *types.Role // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateServiceSpecificCredentialInput ¶
type CreateServiceSpecificCredentialInput struct { // The name of the Amazon Web Services service that is to be associated with the // credentials. The service you specify here is the only service that can be // accessed using these credentials. // // This member is required. ServiceName *string // The name of the IAM user that is to be associated with the credentials. The new // service-specific credentials have the same permissions as the associated user // except that they can be used only to access the specified service. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type CreateServiceSpecificCredentialOutput ¶
type CreateServiceSpecificCredentialOutput struct { // A structure that contains information about the newly created service-specific // credential. // // This is the only time that the password for this credential set is available. // It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential. ServiceSpecificCredential *types.ServiceSpecificCredential // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateUserInput ¶
type CreateUserInput struct { // The name of the user to create. // // IAM user, group, role, and policy names must be unique within the account. // Names are not distinguished by case. For example, you cannot create resources // named both "MyResource" and "myresource". // // This member is required. UserName *string // The path for the user name. For more information about paths, see [IAM identifiers] in the IAM // User Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // [regex pattern]: http://wikipedia.org/wiki/regex Path *string // The ARN of the managed policy that is used to set the permissions boundary for // the user. // // A permissions boundary policy defines the maximum permissions that // identity-based policies can grant to an entity, but does not grant permissions. // Permissions boundaries do not define the maximum permissions that a // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM // User Guide. // // For more information about policy types, see [Policy types] in the IAM User Guide. // // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html PermissionsBoundary *string // A list of tags that you want to attach to the new user. Each tag consists of a // key name and an associated value. For more information about tagging, see [Tagging IAM resources]in // the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreateUserOutput ¶
type CreateUserOutput struct { // A structure with details about the new IAM user. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateUser request.
type CreateVirtualMFADeviceInput ¶
type CreateVirtualMFADeviceInput struct { // The name of the virtual MFA device, which must be unique. Use with path to // uniquely identify a virtual MFA device. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. VirtualMFADeviceName *string // The path for the virtual MFA device. For more information about paths, see [IAM identifiers] in // the IAM User Guide. // // This parameter is optional. If it is not included, it defaults to a slash (/). // // This parameter allows (through its [regex pattern]) a string of characters consisting of // either a forward slash (/) by itself or a string that must begin and end with // forward slashes. In addition, it can contain any ASCII character from the ! ( // \u0021 ) through the DEL character ( \u007F ), including most punctuation // characters, digits, and upper and lowercased letters. // // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // [regex pattern]: http://wikipedia.org/wiki/regex Path *string // A list of tags that you want to attach to the new IAM virtual MFA device. Each // tag consists of a key name and an associated value. For more information about // tagging, see [Tagging IAM resources]in the IAM User Guide. // // If any one of the tags is invalid or if you exceed the allowed maximum number // of tags, then the entire request fails and the resource is not created. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // contains filtered or unexported fields }
type CreateVirtualMFADeviceOutput ¶
type CreateVirtualMFADeviceOutput struct { // A structure containing details about the new virtual MFA device. // // This member is required. VirtualMFADevice *types.VirtualMFADevice // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful CreateVirtualMFADevice request.
type DeactivateMFADeviceInput ¶
type DeactivateMFADeviceInput struct { // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: =,.@:/- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string // The name of the user whose MFA device you want to deactivate. // // This parameter is optional. If no user name is included, it defaults to the // principal making the request. When you make this request with root user // credentials, you must use an [AssumeRoot]session to omit the user name. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [AssumeRoot]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type DeactivateMFADeviceOutput ¶
type DeactivateMFADeviceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccessKeyInput ¶
type DeleteAccessKeyInput struct { // The access key ID for the access key ID and secret access key you want to // delete. // // This parameter allows (through its [regex pattern]) a string of characters that can consist of // any upper or lowercased letter or digit. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccessKeyId *string // The name of the user whose access key pair you want to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type DeleteAccessKeyOutput ¶
type DeleteAccessKeyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccountAliasInput ¶
type DeleteAccountAliasInput struct { // The name of the account alias to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of // lowercase letters, digits, and dashes. You cannot start or finish with a dash, // nor can you have two dashes in a row. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountAlias *string // contains filtered or unexported fields }
type DeleteAccountAliasOutput ¶
type DeleteAccountAliasOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteAccountPasswordPolicyInput ¶
type DeleteAccountPasswordPolicyInput struct {
// contains filtered or unexported fields
}
type DeleteAccountPasswordPolicyOutput ¶
type DeleteAccountPasswordPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteGroupInput ¶
type DeleteGroupInput struct { // The name of the IAM group to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // contains filtered or unexported fields }
type DeleteGroupOutput ¶
type DeleteGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteGroupPolicyInput ¶
type DeleteGroupPolicyInput struct { // The name (friendly name, not ARN) identifying the group that the policy is // embedded in. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // The name identifying the policy document to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // contains filtered or unexported fields }
type DeleteGroupPolicyOutput ¶
type DeleteGroupPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteInstanceProfileInput ¶
type DeleteInstanceProfileInput struct { // The name of the instance profile to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string // contains filtered or unexported fields }
type DeleteInstanceProfileOutput ¶
type DeleteInstanceProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteLoginProfileInput ¶
type DeleteLoginProfileInput struct { // The name of the user whose password you want to delete. // // This parameter is optional. If no user name is included, it defaults to the // principal making the request. When you make this request with root user // credentials, you must use an [AssumeRoot]session to omit the user name. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [AssumeRoot]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type DeleteLoginProfileOutput ¶
type DeleteLoginProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteOpenIDConnectProviderInput ¶
type DeleteOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource // object to delete. You can get a list of OpenID Connect provider resource ARNs by // using the ListOpenIDConnectProvidersoperation. // // This member is required. OpenIDConnectProviderArn *string // contains filtered or unexported fields }
type DeleteOpenIDConnectProviderOutput ¶
type DeleteOpenIDConnectProviderOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePolicyInput ¶
type DeletePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to delete. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // contains filtered or unexported fields }
type DeletePolicyOutput ¶
type DeletePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePolicyVersionInput ¶
type DeletePolicyVersionInput struct { // The Amazon Resource Name (ARN) of the IAM policy from which you want to delete // a version. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The policy version to delete. // // This parameter allows (through its [regex pattern]) a string of characters that consists of // the lowercase letter 'v' followed by one or two digits, and optionally followed // by a period '.' and a string of letters and digits. // // For more information about managed policy versions, see [Versioning for managed policies] in the IAM User Guide. // // [regex pattern]: http://wikipedia.org/wiki/regex // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html // // This member is required. VersionId *string // contains filtered or unexported fields }
type DeletePolicyVersionOutput ¶
type DeletePolicyVersionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRoleInput ¶
type DeleteRoleInput struct { // The name of the role to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type DeleteRoleOutput ¶
type DeleteRoleOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRolePermissionsBoundaryInput ¶
type DeleteRolePermissionsBoundaryInput struct { // The name (friendly name, not ARN) of the IAM role from which you want to remove // the permissions boundary. // // This member is required. RoleName *string // contains filtered or unexported fields }
type DeleteRolePermissionsBoundaryOutput ¶
type DeleteRolePermissionsBoundaryOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRolePolicyInput ¶
type DeleteRolePolicyInput struct { // The name of the inline policy to delete from the specified IAM role. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // The name (friendly name, not ARN) identifying the role that the policy is // embedded in. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type DeleteRolePolicyOutput ¶
type DeleteRolePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSAMLProviderInput ¶
type DeleteSAMLProviderInput struct { // The Amazon Resource Name (ARN) of the SAML provider to delete. // // This member is required. SAMLProviderArn *string // contains filtered or unexported fields }
type DeleteSAMLProviderOutput ¶
type DeleteSAMLProviderOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSSHPublicKeyInput ¶
type DeleteSSHPublicKeyInput struct { // The unique identifier for the SSH public key. // // This parameter allows (through its [regex pattern]) a string of characters that can consist of // any upper or lowercased letter or digit. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SSHPublicKeyId *string // The name of the IAM user associated with the SSH public key. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteSSHPublicKeyOutput ¶
type DeleteSSHPublicKeyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteServerCertificateInput ¶
type DeleteServerCertificateInput struct { // The name of the server certificate you want to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string // contains filtered or unexported fields }
type DeleteServerCertificateOutput ¶
type DeleteServerCertificateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteServiceLinkedRoleInput ¶
type DeleteServiceLinkedRoleInput struct { // The name of the service-linked role to be deleted. // // This member is required. RoleName *string // contains filtered or unexported fields }
type DeleteServiceLinkedRoleOutput ¶
type DeleteServiceLinkedRoleOutput struct { // The deletion task identifier that you can use to check the status of the // deletion. This identifier is returned in the format task/aws-service-role/// . // // This member is required. DeletionTaskId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteServiceSpecificCredentialInput ¶
type DeleteServiceSpecificCredentialInput struct { // The unique identifier of the service-specific credential. You can get this // value by calling ListServiceSpecificCredentials. // // This parameter allows (through its [regex pattern]) a string of characters that can consist of // any upper or lowercased letter or digit. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServiceSpecificCredentialId *string // The name of the IAM user associated with the service-specific credential. If // this value is not specified, then the operation assumes the user whose // credentials are used to call the operation. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type DeleteServiceSpecificCredentialOutput ¶
type DeleteServiceSpecificCredentialOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSigningCertificateInput ¶
type DeleteSigningCertificateInput struct { // The ID of the signing certificate to delete. // // The format of this parameter, as described by its [regex] pattern, is a string of // characters that can be upper- or lower-cased letters or digits. // // [regex]: http://wikipedia.org/wiki/regex // // This member is required. CertificateId *string // The name of the user the signing certificate belongs to. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type DeleteSigningCertificateOutput ¶
type DeleteSigningCertificateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUserInput ¶
type DeleteUserInput struct { // The name of the user to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteUserOutput ¶
type DeleteUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUserPermissionsBoundaryInput ¶
type DeleteUserPermissionsBoundaryInput struct { // The name (friendly name, not ARN) of the IAM user from which you want to remove // the permissions boundary. // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteUserPermissionsBoundaryOutput ¶
type DeleteUserPermissionsBoundaryOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteUserPolicyInput ¶
type DeleteUserPolicyInput struct { // The name identifying the policy document to delete. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // The name (friendly name, not ARN) identifying the user that the policy is // embedded in. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type DeleteUserPolicyOutput ¶
type DeleteUserPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteVirtualMFADeviceInput ¶
type DeleteVirtualMFADeviceInput struct { // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the same as the ARN. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: =,.@:/- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string // contains filtered or unexported fields }
type DeleteVirtualMFADeviceOutput ¶
type DeleteVirtualMFADeviceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DetachGroupPolicyInput ¶
type DetachGroupPolicyInput struct { // The name (friendly name, not ARN) of the IAM group to detach the policy from. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // The Amazon Resource Name (ARN) of the IAM policy you want to detach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // contains filtered or unexported fields }
type DetachGroupPolicyOutput ¶
type DetachGroupPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DetachRolePolicyInput ¶
type DetachRolePolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to detach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM role to detach the policy from. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type DetachRolePolicyOutput ¶
type DetachRolePolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DetachUserPolicyInput ¶
type DetachUserPolicyInput struct { // The Amazon Resource Name (ARN) of the IAM policy you want to detach. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The name (friendly name, not ARN) of the IAM user to detach the policy from. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type DetachUserPolicyOutput ¶
type DetachUserPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisableOrganizationsRootCredentialsManagementInput ¶ added in v1.38.0
type DisableOrganizationsRootCredentialsManagementInput struct {
// contains filtered or unexported fields
}
type DisableOrganizationsRootCredentialsManagementOutput ¶ added in v1.38.0
type DisableOrganizationsRootCredentialsManagementOutput struct { // The features enabled for centralized root access for member accounts in your // organization. EnabledFeatures []types.FeatureType // The unique identifier (ID) of an organization. OrganizationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisableOrganizationsRootSessionsInput ¶ added in v1.38.0
type DisableOrganizationsRootSessionsInput struct {
// contains filtered or unexported fields
}
type DisableOrganizationsRootSessionsOutput ¶ added in v1.38.0
type DisableOrganizationsRootSessionsOutput struct { // The features you have enabled for centralized root access of member accounts in // your organization. EnabledFeatures []types.FeatureType // The unique identifier (ID) of an organization. OrganizationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableMFADeviceInput ¶
type EnableMFADeviceInput struct { // An authentication code emitted by the device. // // The format for this parameter is a string of six digits. // // Submit your request immediately after generating the authentication codes. If // you generate the codes and then wait too long to submit the request, the MFA // device successfully associates with the user but the MFA device becomes out of // sync. This happens because time-based one-time passwords (TOTP) expire after a // short period of time. If this happens, you can [resync the device]. // // [resync the device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html // // This member is required. AuthenticationCode1 *string // A subsequent authentication code emitted by the device. // // The format for this parameter is a string of six digits. // // Submit your request immediately after generating the authentication codes. If // you generate the codes and then wait too long to submit the request, the MFA // device successfully associates with the user but the MFA device becomes out of // sync. This happens because time-based one-time passwords (TOTP) expire after a // short period of time. If this happens, you can [resync the device]. // // [resync the device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html // // This member is required. AuthenticationCode2 *string // The serial number that uniquely identifies the MFA device. For virtual MFA // devices, the serial number is the device ARN. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: =,.@:/- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string // The name of the IAM user for whom you want to enable the MFA device. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type EnableMFADeviceOutput ¶
type EnableMFADeviceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableOrganizationsRootCredentialsManagementInput ¶ added in v1.38.0
type EnableOrganizationsRootCredentialsManagementInput struct {
// contains filtered or unexported fields
}
type EnableOrganizationsRootCredentialsManagementOutput ¶ added in v1.38.0
type EnableOrganizationsRootCredentialsManagementOutput struct { // The features you have enabled for centralized root access. EnabledFeatures []types.FeatureType // The unique identifier (ID) of an organization. OrganizationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableOrganizationsRootSessionsInput ¶ added in v1.38.0
type EnableOrganizationsRootSessionsInput struct {
// contains filtered or unexported fields
}
type EnableOrganizationsRootSessionsOutput ¶ added in v1.38.0
type EnableOrganizationsRootSessionsOutput struct { // The features you have enabled for centralized root access. EnabledFeatures []types.FeatureType // The unique identifier (ID) of an organization. OrganizationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.22.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.22.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.22.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.22.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.22.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GenerateCredentialReportInput ¶
type GenerateCredentialReportInput struct {
// contains filtered or unexported fields
}
type GenerateCredentialReportOutput ¶
type GenerateCredentialReportOutput struct { // Information about the credential report. Description *string // Information about the state of the credential report. State types.ReportStateType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GenerateCredentialReport request.
type GenerateOrganizationsAccessReportInput ¶
type GenerateOrganizationsAccessReportInput struct { // The path of the Organizations entity (root, OU, or account). You can build an // entity path using the known structure of your organization. For example, assume // that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde . // The organization root ID is r-f6g7h8i9j0example and your organization ID is // o-a1b2c3d4e5 . Your entity path is // o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012 . // // This member is required. EntityPath *string // The identifier of the Organizations service control policy (SCP). This // parameter is optional. // // This ID is used to generate information about when an account principal that is // limited by the SCP attempted to access an Amazon Web Services service. OrganizationsPolicyId *string // contains filtered or unexported fields }
type GenerateOrganizationsAccessReportOutput ¶
type GenerateOrganizationsAccessReportOutput struct { // The job identifier that you can use in the GetOrganizationsAccessReport operation. JobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GenerateServiceLastAccessedDetailsInput ¶
type GenerateServiceLastAccessedDetailsInput struct { // The ARN of the IAM resource (user, group, role, or managed policy) used to // generate information about when the resource was last used in an attempt to // access an Amazon Web Services service. // // This member is required. Arn *string // The level of detail that you want to generate. You can specify whether you want // to generate information about the last attempt to access services or actions. If // you specify service-level granularity, this operation generates only service // data. If you specify action-level granularity, it generates service and action // data. If you don't include this optional parameter, the operation generates // service data. Granularity types.AccessAdvisorUsageGranularityType // contains filtered or unexported fields }
type GenerateServiceLastAccessedDetailsOutput ¶
type GenerateServiceLastAccessedDetailsOutput struct { // The JobId that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by // GenerateServiceLastAccessedDetail must be used by the same role within a // session, or by the same user when used to call GetServiceLastAccessedDetail . JobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetAccessKeyLastUsedInput ¶
type GetAccessKeyLastUsedInput struct { // The identifier of an access key. // // This parameter allows (through its [regex pattern]) a string of characters that can consist of // any upper or lowercased letter or digit. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccessKeyId *string // contains filtered or unexported fields }
type GetAccessKeyLastUsedOutput ¶
type GetAccessKeyLastUsedOutput struct { // Contains information about the last time the access key was used. AccessKeyLastUsed *types.AccessKeyLastUsed // The name of the IAM user that owns this access key. UserName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaDatastructure returned by the ListAccessKeys action.
type GetAccountAuthorizationDetailsAPIClient ¶ added in v0.30.0
type GetAccountAuthorizationDetailsAPIClient interface {
GetAccountAuthorizationDetails(context.Context, *GetAccountAuthorizationDetailsInput, ...func(*Options)) (*GetAccountAuthorizationDetailsOutput, error)
}
GetAccountAuthorizationDetailsAPIClient is a client that implements the GetAccountAuthorizationDetails operation.
type GetAccountAuthorizationDetailsInput ¶
type GetAccountAuthorizationDetailsInput struct { // A list of entity types used to filter the results. Only the entities that match // the types you specify are included in the output. Use the value // LocalManagedPolicy to include customer managed policies. // // The format for this parameter is a comma-separated (if more than one) list of // strings. Each string value in the list must be one of the valid values listed // below. Filter []types.EntityType // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. MaxItems *int32 // contains filtered or unexported fields }
type GetAccountAuthorizationDetailsOutput ¶
type GetAccountAuthorizationDetailsOutput struct { // A list containing information about IAM groups. GroupDetailList []types.GroupDetail // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We // recommend that you check IsTruncated after every call to ensure that you // receive all your results. IsTruncated bool // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // A list containing information about managed policies. Policies []types.ManagedPolicyDetail // A list containing information about IAM roles. RoleDetailList []types.RoleDetail // A list containing information about IAM users. UserDetailList []types.UserDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetAccountAuthorizationDetails request.
type GetAccountAuthorizationDetailsPaginator ¶ added in v0.30.0
type GetAccountAuthorizationDetailsPaginator struct {
// contains filtered or unexported fields
}
GetAccountAuthorizationDetailsPaginator is a paginator for GetAccountAuthorizationDetails
func NewGetAccountAuthorizationDetailsPaginator ¶ added in v0.30.0
func NewGetAccountAuthorizationDetailsPaginator(client GetAccountAuthorizationDetailsAPIClient, params *GetAccountAuthorizationDetailsInput, optFns ...func(*GetAccountAuthorizationDetailsPaginatorOptions)) *GetAccountAuthorizationDetailsPaginator
NewGetAccountAuthorizationDetailsPaginator returns a new GetAccountAuthorizationDetailsPaginator
func (*GetAccountAuthorizationDetailsPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetAccountAuthorizationDetailsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetAccountAuthorizationDetailsPaginator) NextPage ¶ added in v0.30.0
func (p *GetAccountAuthorizationDetailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetAccountAuthorizationDetailsOutput, error)
NextPage retrieves the next GetAccountAuthorizationDetails page.
type GetAccountAuthorizationDetailsPaginatorOptions ¶ added in v0.30.0
type GetAccountAuthorizationDetailsPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetAccountAuthorizationDetailsPaginatorOptions is the paginator options for GetAccountAuthorizationDetails
type GetAccountPasswordPolicyInput ¶
type GetAccountPasswordPolicyInput struct {
// contains filtered or unexported fields
}
type GetAccountPasswordPolicyOutput ¶
type GetAccountPasswordPolicyOutput struct { // A structure that contains details about the account's password policy. // // This member is required. PasswordPolicy *types.PasswordPolicy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetAccountPasswordPolicy request.
type GetAccountSummaryInput ¶
type GetAccountSummaryInput struct {
// contains filtered or unexported fields
}
type GetAccountSummaryOutput ¶
type GetAccountSummaryOutput struct { // A set of key–value pairs containing information about IAM entity usage and IAM // quotas. SummaryMap map[string]int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetAccountSummary request.
type GetContextKeysForCustomPolicyInput ¶
type GetContextKeysForCustomPolicyInput struct { // A list of policies for which you want the list of context keys referenced in // those policies. Each document is specified as a string containing the complete, // valid JSON text of an IAM policy. // // The [regex pattern] used to validate this parameter is a string of characters consisting of // the following: // // - Any printable ASCII character ranging from the space character ( \u0020 ) // through the end of the ASCII character range // // - The printable characters in the Basic Latin and Latin-1 Supplement // character set (through \u00FF ) // // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage // return ( \u000D ) // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyInputList []string // contains filtered or unexported fields }
type GetContextKeysForCustomPolicyOutput ¶
type GetContextKeysForCustomPolicyOutput struct { // The list of context keys that are referenced in the input policies. ContextKeyNames []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
type GetContextKeysForPrincipalPolicyInput ¶
type GetContextKeysForPrincipalPolicyInput struct { // The ARN of a user, group, or role whose policies contain the context keys that // you want listed. If you specify a user, the list includes context keys that are // found in all policies that are attached to the user. The list also includes all // groups that the user is a member of. If you pick a group or a role, then it // includes only those context keys that are found in policies attached to that // entity. Note that all parameters are shown in unencoded form here for clarity, // but must be URL encoded to be included as a part of a real HTML request. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicySourceArn *string // An optional list of additional policies for which you want the list of context // keys that are referenced. // // The [regex pattern] used to validate this parameter is a string of characters consisting of // the following: // // - Any printable ASCII character ranging from the space character ( \u0020 ) // through the end of the ASCII character range // // - The printable characters in the Basic Latin and Latin-1 Supplement // character set (through \u00FF ) // // - The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage // return ( \u000D ) // // [regex pattern]: http://wikipedia.org/wiki/regex PolicyInputList []string // contains filtered or unexported fields }
type GetContextKeysForPrincipalPolicyOutput ¶
type GetContextKeysForPrincipalPolicyOutput struct { // The list of context keys that are referenced in the input policies. ContextKeyNames []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
type GetCredentialReportInput ¶
type GetCredentialReportInput struct {
// contains filtered or unexported fields
}
type GetCredentialReportOutput ¶
type GetCredentialReportOutput struct { // Contains the credential report. The report is Base64-encoded. Content []byte // The date and time when the credential report was created, in [ISO 8601 date-time format]. // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 GeneratedTime *time.Time // The format (MIME type) of the credential report. ReportFormat types.ReportFormatType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetCredentialReport request.
type GetGroupAPIClient ¶ added in v0.30.0
type GetGroupAPIClient interface {
GetGroup(context.Context, *GetGroupInput, ...func(*Options)) (*GetGroupOutput, error)
}
GetGroupAPIClient is a client that implements the GetGroup operation.
type GetGroupInput ¶
type GetGroupInput struct { // The name of the group. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. MaxItems *int32 // contains filtered or unexported fields }
type GetGroupOutput ¶
type GetGroupOutput struct { // A structure that contains details about the group. // // This member is required. Group *types.Group // A list of users in the group. // // This member is required. Users []types.User // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We // recommend that you check IsTruncated after every call to ensure that you // receive all your results. IsTruncated bool // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetGroup request.
type GetGroupPaginator ¶ added in v0.30.0
type GetGroupPaginator struct {
// contains filtered or unexported fields
}
GetGroupPaginator is a paginator for GetGroup
func NewGetGroupPaginator ¶ added in v0.30.0
func NewGetGroupPaginator(client GetGroupAPIClient, params *GetGroupInput, optFns ...func(*GetGroupPaginatorOptions)) *GetGroupPaginator
NewGetGroupPaginator returns a new GetGroupPaginator
func (*GetGroupPaginator) HasMorePages ¶ added in v0.30.0
func (p *GetGroupPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetGroupPaginator) NextPage ¶ added in v0.30.0
func (p *GetGroupPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetGroupOutput, error)
NextPage retrieves the next GetGroup page.
type GetGroupPaginatorOptions ¶ added in v0.30.0
type GetGroupPaginatorOptions struct { // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetGroupPaginatorOptions is the paginator options for GetGroup
type GetGroupPolicyInput ¶
type GetGroupPolicyInput struct { // The name of the group the policy is associated with. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string // The name of the policy document to get. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // contains filtered or unexported fields }
type GetGroupPolicyOutput ¶
type GetGroupPolicyOutput struct { // The group the policy is associated with. // // This member is required. GroupName *string // The policy document. // // IAM stores policies in JSON format. However, resources that were created using // CloudFormation templates can be formatted in YAML. CloudFormation always // converts a YAML policy to JSON format before submitting it to IAM. // // This member is required. PolicyDocument *string // The name of the policy. // // This member is required. PolicyName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetGroupPolicy request.
type GetInstanceProfileAPIClient ¶ added in v0.31.0
type GetInstanceProfileAPIClient interface {
GetInstanceProfile(context.Context, *GetInstanceProfileInput, ...func(*Options)) (*GetInstanceProfileOutput, error)
}
GetInstanceProfileAPIClient is a client that implements the GetInstanceProfile operation.
type GetInstanceProfileInput ¶
type GetInstanceProfileInput struct { // The name of the instance profile to get information about. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string // contains filtered or unexported fields }
type GetInstanceProfileOutput ¶
type GetInstanceProfileOutput struct { // A structure containing details about the instance profile. // // This member is required. InstanceProfile *types.InstanceProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetInstanceProfile request.
type GetLoginProfileInput ¶
type GetLoginProfileInput struct { // The name of the user whose login profile you want to retrieve. // // This parameter is optional. If no user name is included, it defaults to the // principal making the request. When you make this request with root user // credentials, you must use an [AssumeRoot]session to omit the user name. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [AssumeRoot]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoot.html // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type GetLoginProfileOutput ¶
type GetLoginProfileOutput struct { // A structure containing the user name and the profile creation date for the user. // // This member is required. LoginProfile *types.LoginProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetLoginProfile request.
type GetMFADeviceInput ¶ added in v1.21.0
type GetMFADeviceInput struct { // Serial number that uniquely identifies the MFA device. For this API, we only // accept FIDO security key [ARNs]. // // [ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html // // This member is required. SerialNumber *string // The friendly name identifying the user. UserName *string // contains filtered or unexported fields }
type GetMFADeviceOutput ¶ added in v1.21.0
type GetMFADeviceOutput struct { // Serial number that uniquely identifies the MFA device. For this API, we only // accept FIDO security key [ARNs]. // // [ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html // // This member is required. SerialNumber *string // The certifications of a specified user's MFA device. We currently provide // FIPS-140-2, FIPS-140-3, and FIDO certification levels obtained from [FIDO Alliance Metadata Service (MDS)]. // // [FIDO Alliance Metadata Service (MDS)]: https://fidoalliance.org/metadata/ Certifications map[string]string // The date that a specified user's MFA device was first enabled. EnableDate *time.Time // The friendly name identifying the user. UserName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOpenIDConnectProviderInput ¶
type GetOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to // get information for. You can get a list of OIDC provider resource ARNs by using // the ListOpenIDConnectProvidersoperation. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. OpenIDConnectProviderArn *string // contains filtered or unexported fields }
type GetOpenIDConnectProviderOutput ¶
type GetOpenIDConnectProviderOutput struct { // A list of client IDs (also known as audiences) that are associated with the // specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider. ClientIDList []string // The date and time when the IAM OIDC provider resource object was created in the // Amazon Web Services account. CreateDate *time.Time // A list of tags that are attached to the specified IAM OIDC provider. The // returned list of tags is sorted by tag key. For more information about tagging, // see [Tagging IAM resources]in the IAM User Guide. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // A list of certificate thumbprints that are associated with the specified IAM // OIDC provider resource object. For more information, see CreateOpenIDConnectProvider. ThumbprintList []string // The URL that the IAM OIDC provider resource object is associated with. For more // information, see CreateOpenIDConnectProvider. Url *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetOpenIDConnectProvider request.
type GetOrganizationsAccessReportInput ¶
type GetOrganizationsAccessReportInput struct { // The identifier of the request generated by the GenerateOrganizationsAccessReport operation. // // This member is required. JobId *string // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. MaxItems *int32 // The key that is used to sort the results. If you choose the namespace key, the // results are returned in alphabetical order. If you choose the time key, the // results are sorted numerically by the date and time. SortKey types.SortKeyType // contains filtered or unexported fields }
type GetOrganizationsAccessReportOutput ¶
type GetOrganizationsAccessReportOutput struct { // The date and time, in [ISO 8601 date-time format], when the report job was created. // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time // The status of the job. // // This member is required. JobStatus types.JobStatusType // An object that contains details about the most recent attempt to access the // service. AccessDetails []types.AccessDetail // Contains information about the reason that the operation failed. // // This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations. ErrorDetails *types.ErrorDetails // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We // recommend that you check IsTruncated after every call to ensure that you // receive all your results. IsTruncated bool // The date and time, in [ISO 8601 date-time format], when the generated report job was completed or failed. // // This field is null if the job is still in progress, as indicated by a job // status value of IN_PROGRESS . // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 JobCompletionDate *time.Time // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // The number of services that the applicable SCPs allow account principals to // access. NumberOfServicesAccessible *int32 // The number of services that account principals are allowed but did not attempt // to access. NumberOfServicesNotAccessed *int32 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetPolicyAPIClient ¶ added in v1.7.0
type GetPolicyAPIClient interface {
GetPolicy(context.Context, *GetPolicyInput, ...func(*Options)) (*GetPolicyOutput, error)
}
GetPolicyAPIClient is a client that implements the GetPolicy operation.
type GetPolicyInput ¶
type GetPolicyInput struct { // The Amazon Resource Name (ARN) of the managed policy that you want information // about. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // contains filtered or unexported fields }
type GetPolicyOutput ¶
type GetPolicyOutput struct { // A structure containing details about the policy. Policy *types.Policy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetPolicy request.
type GetPolicyVersionInput ¶
type GetPolicyVersionInput struct { // The Amazon Resource Name (ARN) of the managed policy that you want information // about. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // Identifies the policy version to retrieve. // // This parameter allows (through its [regex pattern]) a string of characters that consists of // the lowercase letter 'v' followed by one or two digits, and optionally followed // by a period '.' and a string of letters and digits. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. VersionId *string // contains filtered or unexported fields }
type GetPolicyVersionOutput ¶
type GetPolicyVersionOutput struct { // A structure containing details about the policy version. PolicyVersion *types.PolicyVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetPolicyVersion request.
type GetRoleAPIClient ¶ added in v1.7.0
type GetRoleAPIClient interface {
GetRole(context.Context, *GetRoleInput, ...func(*Options)) (*GetRoleOutput, error)
}
GetRoleAPIClient is a client that implements the GetRole operation.
type GetRoleInput ¶
type GetRoleInput struct { // The name of the IAM role to get information about. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type GetRoleOutput ¶
type GetRoleOutput struct { // A structure containing details about the IAM role. // // This member is required. Role *types.Role // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetRole request.
type GetRolePolicyInput ¶
type GetRolePolicyInput struct { // The name of the policy document to get. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // The name of the role associated with the policy. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string // contains filtered or unexported fields }
type GetRolePolicyOutput ¶
type GetRolePolicyOutput struct { // The policy document. // // IAM stores policies in JSON format. However, resources that were created using // CloudFormation templates can be formatted in YAML. CloudFormation always // converts a YAML policy to JSON format before submitting it to IAM. // // This member is required. PolicyDocument *string // The name of the policy. // // This member is required. PolicyName *string // The role the policy is associated with. // // This member is required. RoleName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetRolePolicy request.
type GetSAMLProviderInput ¶
type GetSAMLProviderInput struct { // The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to // get information about. // // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General // Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. SAMLProviderArn *string // contains filtered or unexported fields }
type GetSAMLProviderOutput ¶
type GetSAMLProviderOutput struct { // The date and time when the SAML provider was created. CreateDate *time.Time // The XML metadata document that includes information about an identity provider. SAMLMetadataDocument *string // A list of tags that are attached to the specified IAM SAML provider. The // returned list of tags is sorted by tag key. For more information about tagging, // see [Tagging IAM resources]in the IAM User Guide. // // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // The expiration date and time for the SAML provider. ValidUntil *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetSAMLProvider request.
type GetSSHPublicKeyInput ¶
type GetSSHPublicKeyInput struct { // Specifies the public key encoding format to use in the response. To retrieve // the public key in ssh-rsa format, use SSH . To retrieve the public key in PEM // format, use PEM . // // This member is required. Encoding types.EncodingType // The unique identifier for the SSH public key. // // This parameter allows (through its [regex pattern]) a string of characters that can consist of // any upper or lowercased letter or digit. // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SSHPublicKeyId *string // The name of the IAM user associated with the SSH public key. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type GetSSHPublicKeyOutput ¶
type GetSSHPublicKeyOutput struct { // A structure containing details about the SSH public key. SSHPublicKey *types.SSHPublicKey // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetSSHPublicKey request.
type GetServerCertificateInput ¶
type GetServerCertificateInput struct { // The name of the server certificate you want to retrieve information about. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string // contains filtered or unexported fields }
type GetServerCertificateOutput ¶
type GetServerCertificateOutput struct { // A structure containing details about the server certificate. // // This member is required. ServerCertificate *types.ServerCertificate // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetServerCertificate request.
type GetServiceLastAccessedDetailsInput ¶
type GetServiceLastAccessedDetailsInput struct { // The ID of the request generated by the GenerateServiceLastAccessedDetails operation. The JobId returned by // GenerateServiceLastAccessedDetail must be used by the same role within a // session, or by the same user when used to call GetServiceLastAccessedDetail . // // This member is required. JobId *string // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. MaxItems *int32 // contains filtered or unexported fields }
type GetServiceLastAccessedDetailsOutput ¶
type GetServiceLastAccessedDetailsOutput struct { // The date and time, in [ISO 8601 date-time format], when the generated report job was completed or failed. // // This field is null if the job is still in progress, as indicated by a job // status value of IN_PROGRESS . // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCompletionDate *time.Time // The date and time, in [ISO 8601 date-time format], when the report job was created. // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time // The status of the job. // // This member is required. JobStatus types.JobStatusType // A ServiceLastAccessed object that contains details about the most recent // attempt to access the service. // // This member is required. ServicesLastAccessed []types.ServiceLastAccessed // An object that contains details about the reason the operation failed. Error *types.ErrorDetails // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We // recommend that you check IsTruncated after every call to ensure that you // receive all your results. IsTruncated bool // The type of job. Service jobs return information about when each service was // last accessed. Action jobs also include information about when tracked actions // within the service were last accessed. JobType types.AccessAdvisorUsageGranularityType // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetServiceLastAccessedDetailsWithEntitiesInput ¶
type GetServiceLastAccessedDetailsWithEntitiesInput struct { // The ID of the request generated by the GenerateServiceLastAccessedDetails // operation. // // This member is required. JobId *string // The service namespace for an Amazon Web Services service. Provide the service // namespace to learn when the IAM entity last attempted to access the specified // service. // // To learn the service namespace for a service, see [Actions, resources, and condition keys for Amazon Web Services services] in the IAM User Guide. // Choose the name of the service to view details for that service. In the first // paragraph, find the service prefix. For example, (service prefix: a4b) . For // more information about service namespaces, see [Amazon Web Services service namespaces]in the Amazon Web Services // General Reference. // // [Amazon Web Services service namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces // [Actions, resources, and condition keys for Amazon Web Services services]: https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html // // This member is required. ServiceNamespace *string // Use this parameter only when paginating results and only after you receive a // response indicating that the results are truncated. Set it to the value of the // Marker element in the response that you received to indicate where the next call // should start. Marker *string // Use this only when paginating results to indicate the maximum number of items // you want in the response. If additional items exist beyond the maximum you // specify, the IsTruncated response element is true . // // If you do not include this parameter, the number of items defaults to 100. Note // that IAM might return fewer results, even when there are more results available. // In that case, the IsTruncated response element returns true , and Marker // contains a value to include in the subsequent call that tells the service where // to continue from. MaxItems *int32 // contains filtered or unexported fields }
type GetServiceLastAccessedDetailsWithEntitiesOutput ¶
type GetServiceLastAccessedDetailsWithEntitiesOutput struct { // An EntityDetailsList object that contains details about when an IAM entity // (user or role) used group or policy permissions in an attempt to access the // specified Amazon Web Services service. // // This member is required. EntityDetailsList []types.EntityDetails // The date and time, in [ISO 8601 date-time format], when the generated report job was completed or failed. // // This field is null if the job is still in progress, as indicated by a job // status value of IN_PROGRESS . // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCompletionDate *time.Time // The date and time, in [ISO 8601 date-time format], when the report job was created. // // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time // The status of the job. // // This member is required. JobStatus types.JobStatusType // An object that contains details about the reason the operation failed. Error *types.ErrorDetails // A flag that indicates whether there are more items to return. If your results // were truncated, you can make a subsequent pagination request using the Marker // request parameter to retrieve more items. Note that IAM might return fewer than // the MaxItems number of results even when there are more results available. We // recommend that you check IsTruncated after every call to ensure that you // receive all your results. IsTruncated bool // When IsTruncated is true , this element is present and contains the value to use // for the Marker parameter in a subsequent pagination request. Marker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetServiceLinkedRoleDeletionStatusInput ¶
type GetServiceLinkedRoleDeletionStatusInput struct { // The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in // the format task/aws-service-role/// . // // This member is required. DeletionTaskId *string // contains filtered or unexported fields }
type GetServiceLinkedRoleDeletionStatusOutput ¶
type GetServiceLinkedRoleDeletionStatusOutput struct { // The status of the deletion. // // This member is required. Status types.DeletionTaskStatusType // An object that contains details about the reason the deletion failed. Reason *types.DeletionTaskFailureReasonType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetUserAPIClient ¶ added in v1.7.0
type GetUserAPIClient interface {
GetUser(context.Context, *GetUserInput, ...func(*Options)) (*GetUserOutput, error)
}
GetUserAPIClient is a client that implements the GetUser operation.
type GetUserInput ¶
type GetUserInput struct { // The name of the user to get information about. // // This parameter is optional. If it is not included, it defaults to the user // making the request. This parameter allows (through its [regex pattern]) a string of characters // consisting of upper and lowercase alphanumeric characters with no spaces. You // can also include any of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string // contains filtered or unexported fields }
type GetUserOutput ¶
type GetUserOutput struct { // A structure containing details about the IAM user. // // Due to a service issue, password last used data does not include password use // from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects [last sign-in]dates shown // in the IAM console and password last used dates in the [IAM credential report], and returned by this // operation. If users signed in during the affected time, the password last used // date that is returned is the date the user last signed in before May 3, 2018. // For users that signed in after May 23, 2018 14:08 PDT, the returned password // last used date is accurate. // // You can use password last used information to identify unused credentials for // deletion. For example, you might delete users who did not sign in to Amazon Web // Services in the last 90 days. In cases like this, we recommend that you adjust // your evaluation window to include dates after May 23, 2018. Alternatively, if // your users use access keys to access Amazon Web Services programmatically you // can refer to access key last used information because it is accurate for all // dates. // // [IAM credential report]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html // [last sign-in]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html // // This member is required. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetUser request.
type GetUserPolicyInput ¶
type GetUserPolicyInput struct { // The name of the policy document to get. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string // The name of the user who the policy is associated with. // // This parameter allows (through its [regex pattern]) a string of characters consisting of upper // and lowercase alphanumeric characters with no spaces. You can also include any // of the following characters: _+=,.@- // // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string // contains filtered or unexported fields }
type GetUserPolicyOutput ¶
type GetUserPolicyOutput struct { // The policy document. // // IAM stores policies in JSON format. However, resources that were created using // CloudFormation templates can be formatted in YAML. CloudFormation always // converts a YAML policy to JSON format before submitting it to IAM. // // This member is required. PolicyDocument *string // The name of the policy. // // This member is required. PolicyName *string // The user the policy is associated with. // // This member is required. UserName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Contains the response to a successful GetUserPolicy request.
type HTTPSignerV4 ¶
type InstanceProfileExistsWaiter ¶ added in v0.31.0
type InstanceProfileExistsWaiter struct {
// contains filtered or unexported fields
}
InstanceProfileExistsWaiter defines the waiters for InstanceProfileExists
func NewInstanceProfileExistsWaiter ¶ added in v0.31.0
func NewInstanceProfileExistsWaiter(client GetInstanceProfileAPIClient, optFns ...func(*InstanceProfileExistsWaiterOptions)) *InstanceProfileExistsWaiter
NewInstanceProfileExistsWaiter constructs a InstanceProfileExistsWaiter.
func (*InstanceProfileExistsWaiter) Wait ¶ added in v0.31.0
func (w *InstanceProfileExistsWaiter) Wait(ctx context.Context, params *GetInstanceProfileInput, maxWaitDur time.Duration, optFns ...func(*InstanceProfileExistsWaiterOptions)) error
Wait calls the waiter function for InstanceProfileExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*InstanceProfileExistsWaiter) WaitForOutput ¶ added in v1.13.0
func (w *InstanceProfileExistsWaiter) WaitForOutput(ctx context.Context, params *GetInstanceProfileInput, maxWaitDur time.Duration, optFns ...func(*InstanceProfileExistsWaiterOptions)) (*GetInstanceProfileOutput, error)
WaitForOutput calls the waiter function for InstanceProfileExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type InstanceProfileExistsWaiterOptions ¶ added in v0.31.0
type InstanceProfileExistsWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // mod