func ConflictExceptionReason_Values() []string
ConflictExceptionReason_Values returns all elements of the ConflictExceptionReason enum
func ResourceType_Values() []string
ResourceType_Values returns all elements of the ResourceType enum
type AccessDeniedException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
You do not have sufficient access to perform this action.
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Address struct {
// The country of the address.
//
// Country is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Country *string `min:"1" type:"string" sensitive:"true"`
// A string containing a formatted version of the address for display.
//
// Formatted is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Formatted *string `min:"1" type:"string" sensitive:"true"`
// A string of the address locality.
//
// Locality is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Locality *string `min:"1" type:"string" sensitive:"true"`
// The postal code of the address.
//
// PostalCode is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
PostalCode *string `min:"1" type:"string" sensitive:"true"`
// A Boolean value representing whether this is the primary address for the
// associated resource.
//
// Primary is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Primary *bool `type:"boolean" sensitive:"true"`
// The region of the address.
//
// Region is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Region *string `min:"1" type:"string" sensitive:"true"`
// The street of the address.
//
// StreetAddress is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
StreetAddress *string `min:"1" type:"string" sensitive:"true"`
// A string representing the type of address. For example, "Home."
//
// Type is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Address's
// String and GoString methods.
Type *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
The address associated with the specified user.
func (s Address) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Address) SetCountry(v string) *Address
SetCountry sets the Country field's value.
func (s *Address) SetFormatted(v string) *Address
SetFormatted sets the Formatted field's value.
func (s *Address) SetLocality(v string) *Address
SetLocality sets the Locality field's value.
func (s *Address) SetPostalCode(v string) *Address
SetPostalCode sets the PostalCode field's value.
func (s *Address) SetPrimary(v bool) *Address
SetPrimary sets the Primary field's value.
func (s *Address) SetRegion(v string) *Address
SetRegion sets the Region field's value.
func (s *Address) SetStreetAddress(v string) *Address
SetStreetAddress sets the StreetAddress field's value.
func (s *Address) SetType(v string) *Address
SetType sets the Type field's value.
func (s Address) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Address) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AlternateIdentifier struct {
// The identifier issued to this resource by an external identity provider.
ExternalId *ExternalId `type:"structure"`
// contains filtered or unexported fields
}
A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute.
func (s AlternateIdentifier) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AlternateIdentifier) SetExternalId(v *ExternalId) *AlternateIdentifier
SetExternalId sets the ExternalId field's value.
func (s AlternateIdentifier) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AlternateIdentifier) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AttributeOperation struct {
// A string representation of the path to a given attribute or sub-attribute.
// Supports JMESPath.
//
// AttributePath is a required field
AttributePath *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
An operation that applies to the requested group. This operation might add, replace, or remove an attribute.
func (s AttributeOperation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AttributeOperation) SetAttributePath(v string) *AttributeOperation
SetAttributePath sets the AttributePath field's value.
func (s AttributeOperation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AttributeOperation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConflictException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// This request cannot be completed for one of the following reasons:
//
// * Performing the requested operation would violate an existing uniqueness
// claim in the identity store. Resolve the conflict before retrying this
// request.
//
// * The requested resource was being concurrently modified by another request.
Reason *string `type:"string" enum:"ConflictExceptionReason"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateGroupInput struct {
// A string containing the description of the group.
//
// Description is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateGroupInput's
// String and GoString methods.
Description *string `min:"1" type:"string" sensitive:"true"`
// A string containing the name of the group. This value is commonly displayed
// when the group is referenced. Administrator and AWSAdministrators are reserved
// names and can't be used for users or groups.
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateGroupInput's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CreateGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupInput) SetDescription(v string) *CreateGroupInput
SetDescription sets the Description field's value.
func (s *CreateGroupInput) SetDisplayName(v string) *CreateGroupInput
SetDisplayName sets the DisplayName field's value.
func (s *CreateGroupInput) SetIdentityStoreId(v string) *CreateGroupInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s CreateGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGroupMembershipInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// An object that contains the identifier of a group member. Setting the UserID
// field to the specific identifier for a user indicates that the user is a
// member of the group.
//
// MemberId is a required field
MemberId *MemberId `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s CreateGroupMembershipInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupMembershipInput) SetGroupId(v string) *CreateGroupMembershipInput
SetGroupId sets the GroupId field's value.
func (s *CreateGroupMembershipInput) SetIdentityStoreId(v string) *CreateGroupMembershipInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *CreateGroupMembershipInput) SetMemberId(v *MemberId) *CreateGroupMembershipInput
SetMemberId sets the MemberId field's value.
func (s CreateGroupMembershipInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupMembershipInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGroupMembershipOutput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a newly created GroupMembership in an identity store.
//
// MembershipId is a required field
MembershipId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CreateGroupMembershipOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupMembershipOutput) SetIdentityStoreId(v string) *CreateGroupMembershipOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *CreateGroupMembershipOutput) SetMembershipId(v string) *CreateGroupMembershipOutput
SetMembershipId sets the MembershipId field's value.
func (s CreateGroupMembershipOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateGroupOutput struct {
// The identifier of the newly created group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CreateGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGroupOutput) SetGroupId(v string) *CreateGroupOutput
SetGroupId sets the GroupId field's value.
func (s *CreateGroupOutput) SetIdentityStoreId(v string) *CreateGroupOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s CreateGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateUserInput struct {
// A list of Address objects containing addresses associated with the user.
Addresses []*Address `min:"1" type:"list"`
// A string containing the name of the user. This value is typically formatted
// for display when the user is referenced. For example, "John Doe."
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// A list of Email objects containing email addresses associated with the user.
Emails []*Email `min:"1" type:"list"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// A string containing the geographical region or location of the user.
//
// Locale is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
Locale *string `min:"1" type:"string" sensitive:"true"`
// An object containing the name of the user.
Name *Name `type:"structure"`
// A string containing an alternate name for the user.
//
// NickName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
NickName *string `min:"1" type:"string" sensitive:"true"`
// A list of PhoneNumber objects containing phone numbers associated with the
// user.
PhoneNumbers []*PhoneNumber `min:"1" type:"list"`
// A string containing the preferred language of the user. For example, "American
// English" or "en-us."
//
// PreferredLanguage is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
PreferredLanguage *string `min:"1" type:"string" sensitive:"true"`
// A string containing a URL that might be associated with the user.
//
// ProfileUrl is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
ProfileUrl *string `min:"1" type:"string" sensitive:"true"`
// A string containing the time zone of the user.
//
// Timezone is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
Timezone *string `min:"1" type:"string" sensitive:"true"`
// A string containing the title of the user. Possible values are left unspecified.
// The value can vary based on your specific use case.
//
// Title is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
Title *string `min:"1" type:"string" sensitive:"true"`
// A unique string used to identify the user. The length limit is 128 characters.
// This value can consist of letters, accented characters, symbols, numbers,
// and punctuation. This value is specified at the time the user is created
// and stored as an attribute of the user object in the identity store. Administrator
// and AWSAdministrators are reserved names and can't be used for users or groups.
//
// UserName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
UserName *string `min:"1" type:"string" sensitive:"true"`
// A string indicating the type of user. Possible values are left unspecified.
// The value can vary based on your specific use case.
//
// UserType is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by CreateUserInput's
// String and GoString methods.
UserType *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
func (s CreateUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateUserInput) SetAddresses(v []*Address) *CreateUserInput
SetAddresses sets the Addresses field's value.
func (s *CreateUserInput) SetDisplayName(v string) *CreateUserInput
SetDisplayName sets the DisplayName field's value.
func (s *CreateUserInput) SetEmails(v []*Email) *CreateUserInput
SetEmails sets the Emails field's value.
func (s *CreateUserInput) SetIdentityStoreId(v string) *CreateUserInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *CreateUserInput) SetLocale(v string) *CreateUserInput
SetLocale sets the Locale field's value.
func (s *CreateUserInput) SetName(v *Name) *CreateUserInput
SetName sets the Name field's value.
func (s *CreateUserInput) SetNickName(v string) *CreateUserInput
SetNickName sets the NickName field's value.
func (s *CreateUserInput) SetPhoneNumbers(v []*PhoneNumber) *CreateUserInput
SetPhoneNumbers sets the PhoneNumbers field's value.
func (s *CreateUserInput) SetPreferredLanguage(v string) *CreateUserInput
SetPreferredLanguage sets the PreferredLanguage field's value.
func (s *CreateUserInput) SetProfileUrl(v string) *CreateUserInput
SetProfileUrl sets the ProfileUrl field's value.
func (s *CreateUserInput) SetTimezone(v string) *CreateUserInput
SetTimezone sets the Timezone field's value.
func (s *CreateUserInput) SetTitle(v string) *CreateUserInput
SetTitle sets the Title field's value.
func (s *CreateUserInput) SetUserName(v string) *CreateUserInput
SetUserName sets the UserName field's value.
func (s *CreateUserInput) SetUserType(v string) *CreateUserInput
SetUserType sets the UserType field's value.
func (s CreateUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserOutput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier of the newly created user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s CreateUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateUserOutput) SetIdentityStoreId(v string) *CreateUserOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput
SetUserId sets the UserId field's value.
func (s CreateUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteGroupInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGroupInput) SetGroupId(v string) *DeleteGroupInput
SetGroupId sets the GroupId field's value.
func (s *DeleteGroupInput) SetIdentityStoreId(v string) *DeleteGroupInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s DeleteGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGroupMembershipInput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a GroupMembership in an identity store.
//
// MembershipId is a required field
MembershipId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteGroupMembershipInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGroupMembershipInput) SetIdentityStoreId(v string) *DeleteGroupMembershipInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DeleteGroupMembershipInput) SetMembershipId(v string) *DeleteGroupMembershipInput
SetMembershipId sets the MembershipId field's value.
func (s DeleteGroupMembershipInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGroupMembershipInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGroupMembershipOutput struct {
// contains filtered or unexported fields
}
func (s DeleteGroupMembershipOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteGroupMembershipOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteGroupOutput struct {
// contains filtered or unexported fields
}
func (s DeleteGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteUserInput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DeleteUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteUserInput) SetIdentityStoreId(v string) *DeleteUserInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DeleteUserInput) SetUserId(v string) *DeleteUserInput
SetUserId sets the UserId field's value.
func (s DeleteUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserOutput struct {
// contains filtered or unexported fields
}
func (s DeleteUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeGroupInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store, such as d-1234567890.
// In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
// string that contains numbers and lower case letters. This value is generated
// at the time that a new identity store is created.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupInput) SetGroupId(v string) *DescribeGroupInput
SetGroupId sets the GroupId field's value.
func (s *DescribeGroupInput) SetIdentityStoreId(v string) *DescribeGroupInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s DescribeGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGroupMembershipInput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a GroupMembership in an identity store.
//
// MembershipId is a required field
MembershipId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeGroupMembershipInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupMembershipInput) SetIdentityStoreId(v string) *DescribeGroupMembershipInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DescribeGroupMembershipInput) SetMembershipId(v string) *DescribeGroupMembershipInput
SetMembershipId sets the MembershipId field's value.
func (s DescribeGroupMembershipInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupMembershipInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGroupMembershipOutput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// An object containing the identifier of a group member.
//
// MemberId is a required field
MemberId *MemberId `type:"structure" required:"true"`
// The identifier for a GroupMembership in an identity store.
//
// MembershipId is a required field
MembershipId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeGroupMembershipOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupMembershipOutput) SetGroupId(v string) *DescribeGroupMembershipOutput
SetGroupId sets the GroupId field's value.
func (s *DescribeGroupMembershipOutput) SetIdentityStoreId(v string) *DescribeGroupMembershipOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DescribeGroupMembershipOutput) SetMemberId(v *MemberId) *DescribeGroupMembershipOutput
SetMemberId sets the MemberId field's value.
func (s *DescribeGroupMembershipOutput) SetMembershipId(v string) *DescribeGroupMembershipOutput
SetMembershipId sets the MembershipId field's value.
func (s DescribeGroupMembershipOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeGroupOutput struct {
// A string containing a description of the group.
//
// Description is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeGroupOutput's
// String and GoString methods.
Description *string `min:"1" type:"string" sensitive:"true"`
// The group’s display name value. The length limit is 1,024 characters. This
// value can consist of letters, accented characters, symbols, numbers, punctuation,
// tab, new line, carriage return, space, and nonbreaking space in this attribute.
// This value is specified at the time that the group is created and stored
// as an attribute of the group object in the identity store.
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeGroupOutput's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// A list of ExternalId objects that contains the identifiers issued to this
// resource by an external identity provider.
ExternalIds []*ExternalId `min:"1" type:"list"`
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGroupOutput) SetDescription(v string) *DescribeGroupOutput
SetDescription sets the Description field's value.
func (s *DescribeGroupOutput) SetDisplayName(v string) *DescribeGroupOutput
SetDisplayName sets the DisplayName field's value.
func (s *DescribeGroupOutput) SetExternalIds(v []*ExternalId) *DescribeGroupOutput
SetExternalIds sets the ExternalIds field's value.
func (s *DescribeGroupOutput) SetGroupId(v string) *DescribeGroupOutput
SetGroupId sets the GroupId field's value.
func (s *DescribeGroupOutput) SetIdentityStoreId(v string) *DescribeGroupOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s DescribeGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeUserInput struct {
// The globally unique identifier for the identity store, such as d-1234567890.
// In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
// string that contains numbers and lower case letters. This value is generated
// at the time that a new identity store is created.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s DescribeUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeUserInput) SetIdentityStoreId(v string) *DescribeUserInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput
SetUserId sets the UserId field's value.
func (s DescribeUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserOutput struct {
// The physical address of the user.
Addresses []*Address `min:"1" type:"list"`
// The display name of the user.
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// The email address of the user.
Emails []*Email `min:"1" type:"list"`
// A list of ExternalId objects that contains the identifiers issued to this
// resource by an external identity provider.
ExternalIds []*ExternalId `min:"1" type:"list"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// A string containing the geographical region or location of the user.
//
// Locale is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
Locale *string `min:"1" type:"string" sensitive:"true"`
// The name of the user.
Name *Name `type:"structure"`
// An alternative descriptive name for the user.
//
// NickName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
NickName *string `min:"1" type:"string" sensitive:"true"`
// A list of PhoneNumber objects associated with a user.
PhoneNumbers []*PhoneNumber `min:"1" type:"list"`
// The preferred language of the user.
//
// PreferredLanguage is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
PreferredLanguage *string `min:"1" type:"string" sensitive:"true"`
// A URL link for the user's profile.
//
// ProfileUrl is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
ProfileUrl *string `min:"1" type:"string" sensitive:"true"`
// The time zone for a user.
//
// Timezone is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
Timezone *string `min:"1" type:"string" sensitive:"true"`
// A string containing the title of the user.
//
// Title is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
Title *string `min:"1" type:"string" sensitive:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// A unique string used to identify the user. The length limit is 128 characters.
// This value can consist of letters, accented characters, symbols, numbers,
// and punctuation. This value is specified at the time the user is created
// and stored as an attribute of the user object in the identity store.
//
// UserName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
UserName *string `min:"1" type:"string" sensitive:"true"`
// A string indicating the type of user.
//
// UserType is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by DescribeUserOutput's
// String and GoString methods.
UserType *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
func (s DescribeUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeUserOutput) SetAddresses(v []*Address) *DescribeUserOutput
SetAddresses sets the Addresses field's value.
func (s *DescribeUserOutput) SetDisplayName(v string) *DescribeUserOutput
SetDisplayName sets the DisplayName field's value.
func (s *DescribeUserOutput) SetEmails(v []*Email) *DescribeUserOutput
SetEmails sets the Emails field's value.
func (s *DescribeUserOutput) SetExternalIds(v []*ExternalId) *DescribeUserOutput
SetExternalIds sets the ExternalIds field's value.
func (s *DescribeUserOutput) SetIdentityStoreId(v string) *DescribeUserOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *DescribeUserOutput) SetLocale(v string) *DescribeUserOutput
SetLocale sets the Locale field's value.
func (s *DescribeUserOutput) SetName(v *Name) *DescribeUserOutput
SetName sets the Name field's value.
func (s *DescribeUserOutput) SetNickName(v string) *DescribeUserOutput
SetNickName sets the NickName field's value.
func (s *DescribeUserOutput) SetPhoneNumbers(v []*PhoneNumber) *DescribeUserOutput
SetPhoneNumbers sets the PhoneNumbers field's value.
func (s *DescribeUserOutput) SetPreferredLanguage(v string) *DescribeUserOutput
SetPreferredLanguage sets the PreferredLanguage field's value.
func (s *DescribeUserOutput) SetProfileUrl(v string) *DescribeUserOutput
SetProfileUrl sets the ProfileUrl field's value.
func (s *DescribeUserOutput) SetTimezone(v string) *DescribeUserOutput
SetTimezone sets the Timezone field's value.
func (s *DescribeUserOutput) SetTitle(v string) *DescribeUserOutput
SetTitle sets the Title field's value.
func (s *DescribeUserOutput) SetUserId(v string) *DescribeUserOutput
SetUserId sets the UserId field's value.
func (s *DescribeUserOutput) SetUserName(v string) *DescribeUserOutput
SetUserName sets the UserName field's value.
func (s *DescribeUserOutput) SetUserType(v string) *DescribeUserOutput
SetUserType sets the UserType field's value.
func (s DescribeUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Email struct {
// A Boolean value representing whether this is the primary email address for
// the associated resource.
//
// Primary is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Email's
// String and GoString methods.
Primary *bool `type:"boolean" sensitive:"true"`
// A string representing the type of address. For example, "Work."
//
// Type is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Email's
// String and GoString methods.
Type *string `min:"1" type:"string" sensitive:"true"`
// A string containing an email address. For example, "johndoe@amazon.com."
//
// Value is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Email's
// String and GoString methods.
Value *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
The email address associated with the user.
func (s Email) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Email) SetPrimary(v bool) *Email
SetPrimary sets the Primary field's value.
func (s *Email) SetType(v string) *Email
SetType sets the Type field's value.
func (s *Email) SetValue(v string) *Email
SetValue sets the Value field's value.
func (s Email) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Email) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExternalId struct {
// The identifier issued to this resource by an external identity provider.
//
// Id is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ExternalId's
// String and GoString methods.
//
// Id is a required field
Id *string `min:"1" type:"string" required:"true" sensitive:"true"`
// The issuer for an external identifier.
//
// Issuer is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by ExternalId's
// String and GoString methods.
//
// Issuer is a required field
Issuer *string `min:"1" type:"string" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
The identifier issued to this resource by an external identity provider.
func (s ExternalId) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalId) SetId(v string) *ExternalId
SetId sets the Id field's value.
func (s *ExternalId) SetIssuer(v string) *ExternalId
SetIssuer sets the Issuer field's value.
func (s ExternalId) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExternalId) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Filter struct {
// The attribute path that is used to specify which attribute name to search.
// Length limit is 255 characters. For example, UserName is a valid attribute
// path for the ListUsers API, and DisplayName is a valid attribute path for
// the ListGroups API.
//
// AttributePath is a required field
AttributePath *string `min:"1" type:"string" required:"true"`
// Represents the data for an attribute. Each attribute value is described as
// a name-value pair.
//
// AttributeValue is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Filter's
// String and GoString methods.
//
// AttributeValue is a required field
AttributeValue *string `min:"1" type:"string" required:"true" sensitive:"true"`
// contains filtered or unexported fields
}
A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.
func (s Filter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Filter) SetAttributePath(v string) *Filter
SetAttributePath sets the AttributePath field's value.
func (s *Filter) SetAttributeValue(v string) *Filter
SetAttributeValue sets the AttributeValue field's value.
func (s Filter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Filter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGroupIdInput struct {
// A unique identifier for a user or group that is not the primary identifier.
// This value can be an identifier from an external identity provider (IdP)
// that is associated with the user, the group, or a unique attribute. For the
// unique attribute, the only valid path is displayName.
//
// AlternateIdentifier is a required field
AlternateIdentifier *AlternateIdentifier `type:"structure" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetGroupIdInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupIdInput) SetAlternateIdentifier(v *AlternateIdentifier) *GetGroupIdInput
SetAlternateIdentifier sets the AlternateIdentifier field's value.
func (s *GetGroupIdInput) SetIdentityStoreId(v string) *GetGroupIdInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s GetGroupIdInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupIdInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGroupIdOutput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetGroupIdOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupIdOutput) SetGroupId(v string) *GetGroupIdOutput
SetGroupId sets the GroupId field's value.
func (s *GetGroupIdOutput) SetIdentityStoreId(v string) *GetGroupIdOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s GetGroupIdOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetGroupMembershipIdInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// An object that contains the identifier of a group member. Setting the UserID
// field to the specific identifier for a user indicates that the user is a
// member of the group.
//
// MemberId is a required field
MemberId *MemberId `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s GetGroupMembershipIdInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupMembershipIdInput) SetGroupId(v string) *GetGroupMembershipIdInput
SetGroupId sets the GroupId field's value.
func (s *GetGroupMembershipIdInput) SetIdentityStoreId(v string) *GetGroupMembershipIdInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *GetGroupMembershipIdInput) SetMemberId(v *MemberId) *GetGroupMembershipIdInput
SetMemberId sets the MemberId field's value.
func (s GetGroupMembershipIdInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupMembershipIdInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGroupMembershipIdOutput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a GroupMembership in an identity store.
//
// MembershipId is a required field
MembershipId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetGroupMembershipIdOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetGroupMembershipIdOutput) SetIdentityStoreId(v string) *GetGroupMembershipIdOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *GetGroupMembershipIdOutput) SetMembershipId(v string) *GetGroupMembershipIdOutput
SetMembershipId sets the MembershipId field's value.
func (s GetGroupMembershipIdOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetUserIdInput struct {
// A unique identifier for a user or group that is not the primary identifier.
// This value can be an identifier from an external identity provider (IdP)
// that is associated with the user, the group, or a unique attribute. For the
// unique attribute, the only valid paths are userName and emails.value.
//
// AlternateIdentifier is a required field
AlternateIdentifier *AlternateIdentifier `type:"structure" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetUserIdInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUserIdInput) SetAlternateIdentifier(v *AlternateIdentifier) *GetUserIdInput
SetAlternateIdentifier sets the AlternateIdentifier field's value.
func (s *GetUserIdInput) SetIdentityStoreId(v string) *GetUserIdInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s GetUserIdInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUserIdInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUserIdOutput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s GetUserIdOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetUserIdOutput) SetIdentityStoreId(v string) *GetUserIdOutput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *GetUserIdOutput) SetUserId(v string) *GetUserIdOutput
SetUserId sets the UserId field's value.
func (s GetUserIdOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Group struct {
// A string containing a description of the specified group.
//
// Description is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Group's
// String and GoString methods.
Description *string `min:"1" type:"string" sensitive:"true"`
// The display name value for the group. The length limit is 1,024 characters.
// This value can consist of letters, accented characters, symbols, numbers,
// punctuation, tab, new line, carriage return, space, and nonbreaking space
// in this attribute. This value is specified at the time the group is created
// and stored as an attribute of the group object in the identity store.
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Group's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// A list of ExternalId objects that contains the identifiers issued to this
// resource by an external identity provider.
ExternalIds []*ExternalId `min:"1" type:"list"`
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
A group object that contains the metadata and attributes for a specified group.
func (s Group) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Group) SetDescription(v string) *Group
SetDescription sets the Description field's value.
func (s *Group) SetDisplayName(v string) *Group
SetDisplayName sets the DisplayName field's value.
func (s *Group) SetExternalIds(v []*ExternalId) *Group
SetExternalIds sets the ExternalIds field's value.
func (s *Group) SetGroupId(v string) *Group
SetGroupId sets the GroupId field's value.
func (s *Group) SetIdentityStoreId(v string) *Group
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s Group) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GroupMembership struct {
// The identifier for a group in the identity store.
GroupId *string `min:"1" type:"string"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// An object that contains the identifier of a group member. Setting the UserID
// field to the specific identifier for a user indicates that the user is a
// member of the group.
MemberId *MemberId `type:"structure"`
// The identifier for a GroupMembership object in an identity store.
MembershipId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.
func (s GroupMembership) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GroupMembership) SetGroupId(v string) *GroupMembership
SetGroupId sets the GroupId field's value.
func (s *GroupMembership) SetIdentityStoreId(v string) *GroupMembership
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *GroupMembership) SetMemberId(v *MemberId) *GroupMembership
SetMemberId sets the MemberId field's value.
func (s *GroupMembership) SetMembershipId(v string) *GroupMembership
SetMembershipId sets the MembershipId field's value.
func (s GroupMembership) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GroupMembershipExistenceResult struct {
// The identifier for a group in the identity store.
GroupId *string `min:"1" type:"string"`
// An object that contains the identifier of a group member. Setting the UserID
// field to the specific identifier for a user indicates that the user is a
// member of the group.
MemberId *MemberId `type:"structure"`
// Indicates whether a membership relation exists or not.
//
// MembershipExists is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by GroupMembershipExistenceResult's
// String and GoString methods.
MembershipExists *bool `type:"boolean" sensitive:"true"`
// contains filtered or unexported fields
}
Indicates whether a resource is a member of a group in the identity store.
func (s GroupMembershipExistenceResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GroupMembershipExistenceResult) SetGroupId(v string) *GroupMembershipExistenceResult
SetGroupId sets the GroupId field's value.
func (s *GroupMembershipExistenceResult) SetMemberId(v *MemberId) *GroupMembershipExistenceResult
SetMemberId sets the MemberId field's value.
func (s *GroupMembershipExistenceResult) SetMembershipExists(v bool) *GroupMembershipExistenceResult
SetMembershipExists sets the MembershipExists field's value.
func (s GroupMembershipExistenceResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IdentityStore struct {
*client.Client
}
IdentityStore provides the API operation methods for making requests to AWS SSO Identity Store. See this package's package overview docs for details on the service.
IdentityStore methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IdentityStore
New creates a new instance of the IdentityStore client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a IdentityStore client from just a session.
svc := identitystore.New(mySession)
// Create a IdentityStore client with additional configuration
svc := identitystore.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *IdentityStore) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)
CreateGroup API operation for AWS SSO Identity Store.
Creates a group within the specified identity store.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation CreateGroup for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroup
func (c *IdentityStore) CreateGroupMembership(input *CreateGroupMembershipInput) (*CreateGroupMembershipOutput, error)
CreateGroupMembership API operation for AWS SSO Identity Store.
Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation CreateGroupMembership for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembership
func (c *IdentityStore) CreateGroupMembershipRequest(input *CreateGroupMembershipInput) (req *request.Request, output *CreateGroupMembershipOutput)
CreateGroupMembershipRequest generates a "aws/request.Request" representing the client's request for the CreateGroupMembership operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateGroupMembership for more information on using the CreateGroupMembership API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateGroupMembershipRequest method.
req, resp := client.CreateGroupMembershipRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroupMembership
func (c *IdentityStore) CreateGroupMembershipWithContext(ctx aws.Context, input *CreateGroupMembershipInput, opts ...request.Option) (*CreateGroupMembershipOutput, error)
CreateGroupMembershipWithContext is the same as CreateGroupMembership with the addition of the ability to pass a context and additional request options.
See CreateGroupMembership for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)
CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateGroup for more information on using the CreateGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateGroupRequest method.
req, resp := client.CreateGroupRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateGroup
func (c *IdentityStore) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)
CreateGroupWithContext is the same as CreateGroup with the addition of the ability to pass a context and additional request options.
See CreateGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) CreateUser(input *CreateUserInput) (*CreateUserOutput, error)
CreateUser API operation for AWS SSO Identity Store.
Creates a user within the specified identity store.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation CreateUser for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUser
func (c *IdentityStore) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput)
CreateUserRequest generates a "aws/request.Request" representing the client's request for the CreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateUser for more information on using the CreateUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateUserRequest method.
req, resp := client.CreateUserRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/CreateUser
func (c *IdentityStore) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error)
CreateUserWithContext is the same as CreateUser with the addition of the ability to pass a context and additional request options.
See CreateUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)
DeleteGroup API operation for AWS SSO Identity Store.
Delete a group within an identity store given GroupId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DeleteGroup for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroup
func (c *IdentityStore) DeleteGroupMembership(input *DeleteGroupMembershipInput) (*DeleteGroupMembershipOutput, error)
DeleteGroupMembership API operation for AWS SSO Identity Store.
Delete a membership within a group given MembershipId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DeleteGroupMembership for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembership
func (c *IdentityStore) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) (req *request.Request, output *DeleteGroupMembershipOutput)
DeleteGroupMembershipRequest generates a "aws/request.Request" representing the client's request for the DeleteGroupMembership operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteGroupMembership for more information on using the DeleteGroupMembership API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteGroupMembershipRequest method.
req, resp := client.DeleteGroupMembershipRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroupMembership
func (c *IdentityStore) DeleteGroupMembershipWithContext(ctx aws.Context, input *DeleteGroupMembershipInput, opts ...request.Option) (*DeleteGroupMembershipOutput, error)
DeleteGroupMembershipWithContext is the same as DeleteGroupMembership with the addition of the ability to pass a context and additional request options.
See DeleteGroupMembership for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)
DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteGroup for more information on using the DeleteGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteGroup
func (c *IdentityStore) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)
DeleteGroupWithContext is the same as DeleteGroup with the addition of the ability to pass a context and additional request options.
See DeleteGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)
DeleteUser API operation for AWS SSO Identity Store.
Deletes a user within an identity store given UserId.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DeleteUser for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUser
func (c *IdentityStore) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)
DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteUser for more information on using the DeleteUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DeleteUser
func (c *IdentityStore) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)
DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.
See DeleteUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DescribeGroup(input *DescribeGroupInput) (*DescribeGroupOutput, error)
DescribeGroup API operation for AWS SSO Identity Store.
Retrieves the group metadata and attributes from GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DescribeGroup for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup
func (c *IdentityStore) DescribeGroupMembership(input *DescribeGroupMembershipInput) (*DescribeGroupMembershipOutput, error)
DescribeGroupMembership API operation for AWS SSO Identity Store.
Retrieves membership metadata and attributes from MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DescribeGroupMembership for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembership
func (c *IdentityStore) DescribeGroupMembershipRequest(input *DescribeGroupMembershipInput) (req *request.Request, output *DescribeGroupMembershipOutput)
DescribeGroupMembershipRequest generates a "aws/request.Request" representing the client's request for the DescribeGroupMembership operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeGroupMembership for more information on using the DescribeGroupMembership API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeGroupMembershipRequest method.
req, resp := client.DescribeGroupMembershipRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupMembership
func (c *IdentityStore) DescribeGroupMembershipWithContext(ctx aws.Context, input *DescribeGroupMembershipInput, opts ...request.Option) (*DescribeGroupMembershipOutput, error)
DescribeGroupMembershipWithContext is the same as DescribeGroupMembership with the addition of the ability to pass a context and additional request options.
See DescribeGroupMembership for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DescribeGroupRequest(input *DescribeGroupInput) (req *request.Request, output *DescribeGroupOutput)
DescribeGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeGroup for more information on using the DescribeGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeGroupRequest method.
req, resp := client.DescribeGroupRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup
func (c *IdentityStore) DescribeGroupWithContext(ctx aws.Context, input *DescribeGroupInput, opts ...request.Option) (*DescribeGroupOutput, error)
DescribeGroupWithContext is the same as DescribeGroup with the addition of the ability to pass a context and additional request options.
See DescribeGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)
DescribeUser API operation for AWS SSO Identity Store.
Retrieves the user metadata and attributes from the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation DescribeUser for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser
func (c *IdentityStore) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)
DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeUser for more information on using the DescribeUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeUserRequest method.
req, resp := client.DescribeUserRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser
func (c *IdentityStore) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)
DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.
See DescribeUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) GetGroupId(input *GetGroupIdInput) (*GetGroupIdOutput, error)
GetGroupId API operation for AWS SSO Identity Store.
Retrieves GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation GetGroupId for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupId
func (c *IdentityStore) GetGroupIdRequest(input *GetGroupIdInput) (req *request.Request, output *GetGroupIdOutput)
GetGroupIdRequest generates a "aws/request.Request" representing the client's request for the GetGroupId operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetGroupId for more information on using the GetGroupId API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetGroupIdRequest method.
req, resp := client.GetGroupIdRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupId
func (c *IdentityStore) GetGroupIdWithContext(ctx aws.Context, input *GetGroupIdInput, opts ...request.Option) (*GetGroupIdOutput, error)
GetGroupIdWithContext is the same as GetGroupId with the addition of the ability to pass a context and additional request options.
See GetGroupId for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) GetGroupMembershipId(input *GetGroupMembershipIdInput) (*GetGroupMembershipIdOutput, error)
GetGroupMembershipId API operation for AWS SSO Identity Store.
Retrieves the MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation GetGroupMembershipId for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipId
func (c *IdentityStore) GetGroupMembershipIdRequest(input *GetGroupMembershipIdInput) (req *request.Request, output *GetGroupMembershipIdOutput)
GetGroupMembershipIdRequest generates a "aws/request.Request" representing the client's request for the GetGroupMembershipId operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetGroupMembershipId for more information on using the GetGroupMembershipId API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetGroupMembershipIdRequest method.
req, resp := client.GetGroupMembershipIdRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetGroupMembershipId
func (c *IdentityStore) GetGroupMembershipIdWithContext(ctx aws.Context, input *GetGroupMembershipIdInput, opts ...request.Option) (*GetGroupMembershipIdOutput, error)
GetGroupMembershipIdWithContext is the same as GetGroupMembershipId with the addition of the ability to pass a context and additional request options.
See GetGroupMembershipId for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) GetUserId(input *GetUserIdInput) (*GetUserIdOutput, error)
GetUserId API operation for AWS SSO Identity Store.
Retrieves the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation GetUserId for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserId
func (c *IdentityStore) GetUserIdRequest(input *GetUserIdInput) (req *request.Request, output *GetUserIdOutput)
GetUserIdRequest generates a "aws/request.Request" representing the client's request for the GetUserId operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetUserId for more information on using the GetUserId API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetUserIdRequest method.
req, resp := client.GetUserIdRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/GetUserId
func (c *IdentityStore) GetUserIdWithContext(ctx aws.Context, input *GetUserIdInput, opts ...request.Option) (*GetUserIdOutput, error)
GetUserIdWithContext is the same as GetUserId with the addition of the ability to pass a context and additional request options.
See GetUserId for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) IsMemberInGroups(input *IsMemberInGroupsInput) (*IsMemberInGroupsOutput, error)
IsMemberInGroups API operation for AWS SSO Identity Store.
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation IsMemberInGroups for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroups
func (c *IdentityStore) IsMemberInGroupsRequest(input *IsMemberInGroupsInput) (req *request.Request, output *IsMemberInGroupsOutput)
IsMemberInGroupsRequest generates a "aws/request.Request" representing the client's request for the IsMemberInGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See IsMemberInGroups for more information on using the IsMemberInGroups API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the IsMemberInGroupsRequest method.
req, resp := client.IsMemberInGroupsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/IsMemberInGroups
func (c *IdentityStore) IsMemberInGroupsWithContext(ctx aws.Context, input *IsMemberInGroupsInput, opts ...request.Option) (*IsMemberInGroupsOutput, error)
IsMemberInGroupsWithContext is the same as IsMemberInGroups with the addition of the ability to pass a context and additional request options.
See IsMemberInGroups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroupMemberships(input *ListGroupMembershipsInput) (*ListGroupMembershipsOutput, error)
ListGroupMemberships API operation for AWS SSO Identity Store.
For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation ListGroupMemberships for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMemberships
func (c *IdentityStore) ListGroupMembershipsForMember(input *ListGroupMembershipsForMemberInput) (*ListGroupMembershipsForMemberOutput, error)
ListGroupMembershipsForMember API operation for AWS SSO Identity Store.
For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation ListGroupMembershipsForMember for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMember
func (c *IdentityStore) ListGroupMembershipsForMemberPages(input *ListGroupMembershipsForMemberInput, fn func(*ListGroupMembershipsForMemberOutput, bool) bool) error
ListGroupMembershipsForMemberPages iterates over the pages of a ListGroupMembershipsForMember operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListGroupMembershipsForMember method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListGroupMembershipsForMember operation.
pageNum := 0
err := client.ListGroupMembershipsForMemberPages(params,
func(page *identitystore.ListGroupMembershipsForMemberOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IdentityStore) ListGroupMembershipsForMemberPagesWithContext(ctx aws.Context, input *ListGroupMembershipsForMemberInput, fn func(*ListGroupMembershipsForMemberOutput, bool) bool, opts ...request.Option) error
ListGroupMembershipsForMemberPagesWithContext same as ListGroupMembershipsForMemberPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroupMembershipsForMemberRequest(input *ListGroupMembershipsForMemberInput) (req *request.Request, output *ListGroupMembershipsForMemberOutput)
ListGroupMembershipsForMemberRequest generates a "aws/request.Request" representing the client's request for the ListGroupMembershipsForMember operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListGroupMembershipsForMember for more information on using the ListGroupMembershipsForMember API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListGroupMembershipsForMemberRequest method.
req, resp := client.ListGroupMembershipsForMemberRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMembershipsForMember
func (c *IdentityStore) ListGroupMembershipsForMemberWithContext(ctx aws.Context, input *ListGroupMembershipsForMemberInput, opts ...request.Option) (*ListGroupMembershipsForMemberOutput, error)
ListGroupMembershipsForMemberWithContext is the same as ListGroupMembershipsForMember with the addition of the ability to pass a context and additional request options.
See ListGroupMembershipsForMember for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroupMembershipsPages(input *ListGroupMembershipsInput, fn func(*ListGroupMembershipsOutput, bool) bool) error
ListGroupMembershipsPages iterates over the pages of a ListGroupMemberships operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListGroupMemberships method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListGroupMemberships operation.
pageNum := 0
err := client.ListGroupMembershipsPages(params,
func(page *identitystore.ListGroupMembershipsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IdentityStore) ListGroupMembershipsPagesWithContext(ctx aws.Context, input *ListGroupMembershipsInput, fn func(*ListGroupMembershipsOutput, bool) bool, opts ...request.Option) error
ListGroupMembershipsPagesWithContext same as ListGroupMembershipsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroupMembershipsRequest(input *ListGroupMembershipsInput) (req *request.Request, output *ListGroupMembershipsOutput)
ListGroupMembershipsRequest generates a "aws/request.Request" representing the client's request for the ListGroupMemberships operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListGroupMemberships for more information on using the ListGroupMemberships API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListGroupMembershipsRequest method.
req, resp := client.ListGroupMembershipsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupMemberships
func (c *IdentityStore) ListGroupMembershipsWithContext(ctx aws.Context, input *ListGroupMembershipsInput, opts ...request.Option) (*ListGroupMembershipsOutput, error)
ListGroupMembershipsWithContext is the same as ListGroupMemberships with the addition of the ability to pass a context and additional request options.
See ListGroupMemberships for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)
ListGroups API operation for AWS SSO Identity Store.
Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation ListGroups for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups
func (c *IdentityStore) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error
ListGroupsPages iterates over the pages of a ListGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListGroups method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListGroups operation.
pageNum := 0
err := client.ListGroupsPages(params,
func(page *identitystore.ListGroupsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IdentityStore) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error
ListGroupsPagesWithContext same as ListGroupsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)
ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListGroups for more information on using the ListGroups API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups
func (c *IdentityStore) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)
ListGroupsWithContext is the same as ListGroups with the addition of the ability to pass a context and additional request options.
See ListGroups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)
ListUsers API operation for AWS SSO Identity Store.
Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) in the Organizations User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation ListUsers for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers
func (c *IdentityStore) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error
ListUsersPages iterates over the pages of a ListUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListUsers method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListUsers operation.
pageNum := 0
err := client.ListUsersPages(params,
func(page *identitystore.ListUsersOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *IdentityStore) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error
ListUsersPagesWithContext same as ListUsersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)
ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListUsers for more information on using the ListUsers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListUsersRequest method.
req, resp := client.ListUsersRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers
func (c *IdentityStore) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)
ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.
See ListUsers for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) UpdateGroup(input *UpdateGroupInput) (*UpdateGroupOutput, error)
UpdateGroup API operation for AWS SSO Identity Store.
For the specified group in the specified identity store, updates the group metadata and attributes.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation UpdateGroup for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroup
func (c *IdentityStore) UpdateGroupRequest(input *UpdateGroupInput) (req *request.Request, output *UpdateGroupOutput)
UpdateGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateGroup for more information on using the UpdateGroup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateGroupRequest method.
req, resp := client.UpdateGroupRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateGroup
func (c *IdentityStore) UpdateGroupWithContext(ctx aws.Context, input *UpdateGroupInput, opts ...request.Option) (*UpdateGroupOutput, error)
UpdateGroupWithContext is the same as UpdateGroup with the addition of the ability to pass a context and additional request options.
See UpdateGroup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IdentityStore) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)
UpdateUser API operation for AWS SSO Identity Store.
For the specified user in the specified identity store, updates the user metadata and attributes.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS SSO Identity Store's API operation UpdateUser for usage and error information.
Returned Error Types:
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException You do not have sufficient access to perform this action.
ConflictException This request cannot be completed for one of the following reasons:
Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException The request failed because it contains a syntax error.
ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUser
func (c *IdentityStore) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)
UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateUser for more information on using the UpdateUser API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/UpdateUser
func (c *IdentityStore) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)
UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.
See UpdateUser for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type InternalServerException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// The number of seconds to wait before retrying the next request.
RetryAfterSeconds *int64 `type:"integer"`
// contains filtered or unexported fields
}
The request processing has failed because of an unknown error, exception or failure with an internal server.
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IsMemberInGroupsInput struct {
// A list of identifiers for groups in the identity store.
//
// GroupIds is a required field
GroupIds []*string `min:"1" type:"list" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// An object containing the identifier of a group member.
//
// MemberId is a required field
MemberId *MemberId `type:"structure" required:"true"`
// contains filtered or unexported fields
}
func (s IsMemberInGroupsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IsMemberInGroupsInput) SetGroupIds(v []*string) *IsMemberInGroupsInput
SetGroupIds sets the GroupIds field's value.
func (s *IsMemberInGroupsInput) SetIdentityStoreId(v string) *IsMemberInGroupsInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *IsMemberInGroupsInput) SetMemberId(v *MemberId) *IsMemberInGroupsInput
SetMemberId sets the MemberId field's value.
func (s IsMemberInGroupsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IsMemberInGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IsMemberInGroupsOutput struct {
// A list containing the results of membership existence checks.
//
// Results is a required field
Results []*GroupMembershipExistenceResult `type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s IsMemberInGroupsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IsMemberInGroupsOutput) SetResults(v []*GroupMembershipExistenceResult) *IsMemberInGroupsOutput
SetResults sets the Results field's value.
func (s IsMemberInGroupsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListGroupMembershipsForMemberInput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The maximum number of results to be returned per request. This parameter
// is used in the ListUsers and ListGroups requests to specify how many results
// to return in one page. The length limit is 50 characters.
MaxResults *int64 `min:"1" type:"integer"`
// An object that contains the identifier of a group member. Setting the UserID
// field to the specific identifier for a user indicates that the user is a
// member of the group.
//
// MemberId is a required field
MemberId *MemberId `type:"structure" required:"true"`
// The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships
// API operations. This value is generated by the identity store service. It
// is returned in the API response if the total results are more than the size
// of one page. This token is also returned when it is used in the API request
// to search for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupMembershipsForMemberInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsForMemberInput) SetIdentityStoreId(v string) *ListGroupMembershipsForMemberInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *ListGroupMembershipsForMemberInput) SetMaxResults(v int64) *ListGroupMembershipsForMemberInput
SetMaxResults sets the MaxResults field's value.
func (s *ListGroupMembershipsForMemberInput) SetMemberId(v *MemberId) *ListGroupMembershipsForMemberInput
SetMemberId sets the MemberId field's value.
func (s *ListGroupMembershipsForMemberInput) SetNextToken(v string) *ListGroupMembershipsForMemberInput
SetNextToken sets the NextToken field's value.
func (s ListGroupMembershipsForMemberInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsForMemberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupMembershipsForMemberOutput struct {
// A list of GroupMembership objects in the group for a specified member.
//
// GroupMemberships is a required field
GroupMemberships []*GroupMembership `type:"list" required:"true"`
// The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships
// API operations. This value is generated by the identity store service. It
// is returned in the API response if the total results are more than the size
// of one page. This token is also returned when it is used in the API request
// to search for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupMembershipsForMemberOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsForMemberOutput) SetGroupMemberships(v []*GroupMembership) *ListGroupMembershipsForMemberOutput
SetGroupMemberships sets the GroupMemberships field's value.
func (s *ListGroupMembershipsForMemberOutput) SetNextToken(v string) *ListGroupMembershipsForMemberOutput
SetNextToken sets the NextToken field's value.
func (s ListGroupMembershipsForMemberOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListGroupMembershipsInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The maximum number of results to be returned per request. This parameter
// is used in all List requests to specify how many results to return in one
// page.
MaxResults *int64 `min:"1" type:"integer"`
// The pagination token used for the ListUsers, ListGroups and ListGroupMemberships
// API operations. This value is generated by the identity store service. It
// is returned in the API response if the total results are more than the size
// of one page. This token is also returned when it is used in the API request
// to search for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupMembershipsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsInput) SetGroupId(v string) *ListGroupMembershipsInput
SetGroupId sets the GroupId field's value.
func (s *ListGroupMembershipsInput) SetIdentityStoreId(v string) *ListGroupMembershipsInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *ListGroupMembershipsInput) SetMaxResults(v int64) *ListGroupMembershipsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListGroupMembershipsInput) SetNextToken(v string) *ListGroupMembershipsInput
SetNextToken sets the NextToken field's value.
func (s ListGroupMembershipsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupMembershipsOutput struct {
// A list of GroupMembership objects in the group.
//
// GroupMemberships is a required field
GroupMemberships []*GroupMembership `type:"list" required:"true"`
// The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships
// API operations. This value is generated by the identity store service. It
// is returned in the API response if the total results are more than the size
// of one page. This token is also returned when it is used in the API request
// to search for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupMembershipsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupMembershipsOutput) SetGroupMemberships(v []*GroupMembership) *ListGroupMembershipsOutput
SetGroupMemberships sets the GroupMemberships field's value.
func (s *ListGroupMembershipsOutput) SetNextToken(v string) *ListGroupMembershipsOutput
SetNextToken sets the NextToken field's value.
func (s ListGroupMembershipsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListGroupsInput struct {
// A list of Filter objects, which is used in the ListUsers and ListGroups requests.
//
// Deprecated: Using filters with ListGroups API is deprecated, please use GetGroupId API instead.
Filters []*Filter `deprecated:"true" type:"list"`
// The globally unique identifier for the identity store, such as d-1234567890.
// In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
// string that contains numbers and lower case letters. This value is generated
// at the time that a new identity store is created.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The maximum number of results to be returned per request. This parameter
// is used in the ListUsers and ListGroups requests to specify how many results
// to return in one page. The length limit is 50 characters.
MaxResults *int64 `min:"1" type:"integer"`
// The pagination token used for the ListUsers and ListGroups API operations.
// This value is generated by the identity store service. It is returned in
// the API response if the total results are more than the size of one page.
// This token is also returned when it is used in the API request to search
// for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupsInput) SetFilters(v []*Filter) *ListGroupsInput
SetFilters sets the Filters field's value.
func (s *ListGroupsInput) SetIdentityStoreId(v string) *ListGroupsInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput
SetNextToken sets the NextToken field's value.
func (s ListGroupsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupsOutput struct {
// A list of Group objects in the identity store.
//
// Groups is a required field
Groups []*Group `type:"list" required:"true"`
// The pagination token used for the ListUsers and ListGroups API operations.
// This value is generated by the identity store service. It is returned in
// the API response if the total results are more than the size of one page.
// This token is also returned when it1 is used in the API request to search
// for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListGroupsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListGroupsOutput) SetGroups(v []*Group) *ListGroupsOutput
SetGroups sets the Groups field's value.
func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput
SetNextToken sets the NextToken field's value.
func (s ListGroupsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListUsersInput struct {
// A list of Filter objects, which is used in the ListUsers and ListGroups requests.
//
// Deprecated: Using filters with ListUsers API is deprecated, please use GetGroupId API instead.
Filters []*Filter `deprecated:"true" type:"list"`
// The globally unique identifier for the identity store, such as d-1234567890.
// In this example, d- is a fixed prefix, and 1234567890 is a randomly generated
// string that contains numbers and lower case letters. This value is generated
// at the time that a new identity store is created.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// The maximum number of results to be returned per request. This parameter
// is used in the ListUsers and ListGroups requests to specify how many results
// to return in one page. The length limit is 50 characters.
MaxResults *int64 `min:"1" type:"integer"`
// The pagination token used for the ListUsers and ListGroups API operations.
// This value is generated by the identity store service. It is returned in
// the API response if the total results are more than the size of one page.
// This token is also returned when it is used in the API request to search
// for the next page.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListUsersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListUsersInput) SetFilters(v []*Filter) *ListUsersInput
SetFilters sets the Filters field's value.
func (s *ListUsersInput) SetIdentityStoreId(v string) *ListUsersInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput
SetMaxResults sets the MaxResults field's value.
func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput
SetNextToken sets the NextToken field's value.
func (s ListUsersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUsersOutput struct {
// The pagination token used for the ListUsers and ListGroups API operations.
// This value is generated by the identity store service. It is returned in
// the API response if the total results are more than the size of one page.
// This token is also returned when it is used in the API request to search
// for the next page.
NextToken *string `min:"1" type:"string"`
// A list of User objects in the identity store.
//
// Users is a required field
Users []*User `type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s ListUsersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput
SetNextToken sets the NextToken field's value.
func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput
SetUsers sets the Users field's value.
func (s ListUsersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MemberId struct {
// An object containing the identifiers of resources that can be members.
UserId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
An object containing the identifier of a group member.
func (s MemberId) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MemberId) SetUserId(v string) *MemberId
SetUserId sets the UserId field's value.
func (s MemberId) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MemberId) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Name struct {
// The family name of the user.
//
// FamilyName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
FamilyName *string `min:"1" type:"string" sensitive:"true"`
// A string containing a formatted version of the name for display.
//
// Formatted is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
Formatted *string `min:"1" type:"string" sensitive:"true"`
// The given name of the user.
//
// GivenName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
GivenName *string `min:"1" type:"string" sensitive:"true"`
// The honorific prefix of the user. For example, "Dr."
//
// HonorificPrefix is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
HonorificPrefix *string `min:"1" type:"string" sensitive:"true"`
// The honorific suffix of the user. For example, "M.D."
//
// HonorificSuffix is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
HonorificSuffix *string `min:"1" type:"string" sensitive:"true"`
// The middle name of the user.
//
// MiddleName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by Name's
// String and GoString methods.
MiddleName *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
The full name of the user.
func (s Name) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Name) SetFamilyName(v string) *Name
SetFamilyName sets the FamilyName field's value.
func (s *Name) SetFormatted(v string) *Name
SetFormatted sets the Formatted field's value.
func (s *Name) SetGivenName(v string) *Name
SetGivenName sets the GivenName field's value.
func (s *Name) SetHonorificPrefix(v string) *Name
SetHonorificPrefix sets the HonorificPrefix field's value.
func (s *Name) SetHonorificSuffix(v string) *Name
SetHonorificSuffix sets the HonorificSuffix field's value.
func (s *Name) SetMiddleName(v string) *Name
SetMiddleName sets the MiddleName field's value.
func (s Name) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Name) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PhoneNumber struct {
// A Boolean value representing whether this is the primary phone number for
// the associated resource.
//
// Primary is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PhoneNumber's
// String and GoString methods.
Primary *bool `type:"boolean" sensitive:"true"`
// A string representing the type of a phone number. For example, "Mobile."
//
// Type is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PhoneNumber's
// String and GoString methods.
Type *string `min:"1" type:"string" sensitive:"true"`
// A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
//
// Value is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by PhoneNumber's
// String and GoString methods.
Value *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
The phone number associated with the user.
func (s PhoneNumber) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PhoneNumber) SetPrimary(v bool) *PhoneNumber
SetPrimary sets the Primary field's value.
func (s *PhoneNumber) SetType(v string) *PhoneNumber
SetType sets the Type field's value.
func (s *PhoneNumber) SetValue(v string) *PhoneNumber
SetValue sets the Value field's value.
func (s PhoneNumber) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PhoneNumber) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceNotFoundException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// The identifier for a resource in the identity store that can be used as UserId
// or GroupId. The format for ResourceId is either UUID or 1234567890-UUID,
// where UUID is a randomly generated value for each resource when it is created
// and 1234567890 represents the IdentityStoreId string value. In the case that
// the identity store is migrated from a legacy SSO identity store, the ResourceId
// for that identity store will be in the format of UUID. Otherwise, it will
// be in the 1234567890-UUID format.
ResourceId *string `min:"1" type:"string"`
// An enum object indicating the type of resource in the identity store service.
// Valid values include USER, GROUP, and IDENTITY_STORE.
ResourceType *string `type:"string" enum:"ResourceType"`
// contains filtered or unexported fields
}
Indicates that a requested resource is not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceQuotaExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// The number of seconds to wait before retrying the next request.
RetryAfterSeconds *int64 `type:"integer"`
// contains filtered or unexported fields
}
Indicates that the principal has crossed the throttling limits of the API operations.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateGroupInput struct {
// The identifier for a group in the identity store.
//
// GroupId is a required field
GroupId *string `min:"1" type:"string" required:"true"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// A list of AttributeOperation objects to apply to the requested group. These
// operations might add, replace, or remove an attribute.
//
// Operations is a required field
Operations []*AttributeOperation `min:"1" type:"list" required:"true"`
// contains filtered or unexported fields
}
func (s UpdateGroupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateGroupInput) SetGroupId(v string) *UpdateGroupInput
SetGroupId sets the GroupId field's value.
func (s *UpdateGroupInput) SetIdentityStoreId(v string) *UpdateGroupInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *UpdateGroupInput) SetOperations(v []*AttributeOperation) *UpdateGroupInput
SetOperations sets the Operations field's value.
func (s UpdateGroupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateGroupOutput struct {
// contains filtered or unexported fields
}
func (s UpdateGroupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateGroupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UpdateUserInput struct {
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// A list of AttributeOperation objects to apply to the requested user. These
// operations might add, replace, or remove an attribute.
//
// Operations is a required field
Operations []*AttributeOperation `min:"1" type:"list" required:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s UpdateUserInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateUserInput) SetIdentityStoreId(v string) *UpdateUserInput
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *UpdateUserInput) SetOperations(v []*AttributeOperation) *UpdateUserInput
SetOperations sets the Operations field's value.
func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput
SetUserId sets the UserId field's value.
func (s UpdateUserInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UpdateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserOutput struct {
// contains filtered or unexported fields
}
func (s UpdateUserOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UpdateUserOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type User struct {
// A list of Address objects containing addresses associated with the user.
Addresses []*Address `min:"1" type:"list"`
// A string containing the name of the user that is formatted for display when
// the user is referenced. For example, "John Doe."
//
// DisplayName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
DisplayName *string `min:"1" type:"string" sensitive:"true"`
// A list of Email objects containing email addresses associated with the user.
Emails []*Email `min:"1" type:"list"`
// A list of ExternalId objects that contains the identifiers issued to this
// resource by an external identity provider.
ExternalIds []*ExternalId `min:"1" type:"list"`
// The globally unique identifier for the identity store.
//
// IdentityStoreId is a required field
IdentityStoreId *string `min:"1" type:"string" required:"true"`
// A string containing the geographical region or location of the user.
//
// Locale is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
Locale *string `min:"1" type:"string" sensitive:"true"`
// An object containing the name of the user.
Name *Name `type:"structure"`
// A string containing an alternate name for the user.
//
// NickName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
NickName *string `min:"1" type:"string" sensitive:"true"`
// A list of PhoneNumber objects containing phone numbers associated with the
// user.
PhoneNumbers []*PhoneNumber `min:"1" type:"list"`
// A string containing the preferred language of the user. For example, "American
// English" or "en-us."
//
// PreferredLanguage is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
PreferredLanguage *string `min:"1" type:"string" sensitive:"true"`
// A string containing a URL that might be associated with the user.
//
// ProfileUrl is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
ProfileUrl *string `min:"1" type:"string" sensitive:"true"`
// A string containing the time zone of the user.
//
// Timezone is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
Timezone *string `min:"1" type:"string" sensitive:"true"`
// A string containing the title of the user. Possible values are left unspecified.
// The value can vary based on your specific use case.
//
// Title is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
Title *string `min:"1" type:"string" sensitive:"true"`
// The identifier for a user in the identity store.
//
// UserId is a required field
UserId *string `min:"1" type:"string" required:"true"`
// A unique string used to identify the user. The length limit is 128 characters.
// This value can consist of letters, accented characters, symbols, numbers,
// and punctuation. This value is specified at the time the user is created
// and stored as an attribute of the user object in the identity store.
//
// UserName is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
UserName *string `min:"1" type:"string" sensitive:"true"`
// A string indicating the type of user. Possible values are left unspecified.
// The value can vary based on your specific use case.
//
// UserType is a sensitive parameter and its value will be
// replaced with "sensitive" in string returned by User's
// String and GoString methods.
UserType *string `min:"1" type:"string" sensitive:"true"`
// contains filtered or unexported fields
}
A user object that contains the metadata and attributes for a specified user.
func (s User) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *User) SetAddresses(v []*Address) *User
SetAddresses sets the Addresses field's value.
func (s *User) SetDisplayName(v string) *User
SetDisplayName sets the DisplayName field's value.
func (s *User) SetEmails(v []*Email) *User
SetEmails sets the Emails field's value.
func (s *User) SetExternalIds(v []*ExternalId) *User
SetExternalIds sets the ExternalIds field's value.
func (s *User) SetIdentityStoreId(v string) *User
SetIdentityStoreId sets the IdentityStoreId field's value.
func (s *User) SetLocale(v string) *User
SetLocale sets the Locale field's value.
func (s *User) SetName(v *Name) *User
SetName sets the Name field's value.
func (s *User) SetNickName(v string) *User
SetNickName sets the NickName field's value.
func (s *User) SetPhoneNumbers(v []*PhoneNumber) *User
SetPhoneNumbers sets the PhoneNumbers field's value.
func (s *User) SetPreferredLanguage(v string) *User
SetPreferredLanguage sets the PreferredLanguage field's value.
func (s *User) SetProfileUrl(v string) *User
SetProfileUrl sets the ProfileUrl field's value.
func (s *User) SetTimezone(v string) *User
SetTimezone sets the Timezone field's value.
func (s *User) SetTitle(v string) *User
SetTitle sets the Title field's value.
func (s *User) SetUserId(v string) *User
SetUserId sets the UserId field's value.
func (s *User) SetUserName(v string) *User
SetUserName sets the UserName field's value.
func (s *User) SetUserType(v string) *User
SetUserType sets the UserType field's value.
func (s User) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// The identifier for each request. This value is a globally unique ID that
// is generated by the identity store service for each sent request, and is
// then returned inside the exception if the request fails.
RequestId *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
The request failed because it contains a syntax error.
func (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".