...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/identitystore"
Overview
Constants

Overview ▾

Package identitystore provides the client and types for making API requests to AWS SSO Identity Store.

The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users and groups). For more information about AWS, see the AWS Single Sign-On User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html).

See https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15 for more information on this service.

See identitystore package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/identitystore/

Using the Client

To contact AWS SSO Identity Store with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS SSO Identity Store client IdentityStore for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/identitystore/#New

The stub package, identitystoreiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type IdentityStore
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IdentityStore
func (c *IdentityStore) DescribeGroup(input *DescribeGroupInput) (*DescribeGroupOutput, error)
func (c *IdentityStore) DescribeGroupRequest(input *DescribeGroupInput) (req *request.Request, output *DescribeGroupOutput)
func (c *IdentityStore) DescribeGroupWithContext(ctx aws.Context, input *DescribeGroupInput, opts ...request.Option) (*DescribeGroupOutput, error)
func (c *IdentityStore) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)
func (c *IdentityStore) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)
func (c *IdentityStore) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)
func (c *IdentityStore) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)
func (c *IdentityStore) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error
func (c *IdentityStore) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error
func (c *IdentityStore) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)
func (c *IdentityStore) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)
func (c *IdentityStore) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)
func (c *IdentityStore) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error
func (c *IdentityStore) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error
func (c *IdentityStore) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)
func (c *IdentityStore) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)
func ResourceType_Values() []string
type AccessDeniedException
type DescribeGroupInput
type DescribeGroupOutput
type DescribeUserInput
type DescribeUserOutput
type Filter
type Group
type InternalServerException
type ListGroupsInput
type ListGroupsOutput
type ListUsersInput
type ListUsersOutput
type ResourceNotFoundException
type ThrottlingException
type User
type ValidationException

Constants ▾

const (
    // ResourceTypeGroup is a ResourceType enum value
    ResourceTypeGroup = "GROUP"

    // ResourceTypeUser is a ResourceType enum value
    ResourceTypeUser = "USER"

    // ResourceTypeIdentityStore is a ResourceType enum value
    ResourceTypeIdentityStore = "IDENTITY_STORE"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // You do not have sufficient access to perform this action.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // The request processing has failed because of an unknown error, exception
    // or failure with an internal server.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // Indicates that a requested resource is not found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    //
    // Indicates that the principal has crossed the throttling limits of the API
    // operations.
    ErrCodeThrottlingException = "ThrottlingException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // The request failed because it contains a syntax error.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "identitystore" // Name of service.
    EndpointsID = ServiceName     // ID to lookup a service endpoint with.
    ServiceID   = "identitystore" // ServiceID is a unique identifier of a specific service.
)

Service information constants

func ResourceType_Values

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

type AccessDeniedException

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" 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 `type:"string"`
    // contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation

type DescribeGroupInput

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 number 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 (DescribeGroupInput) GoString

func (s DescribeGroupInput) GoString() string

GoString returns the string representation

func (*DescribeGroupInput) SetGroupId

func (s *DescribeGroupInput) SetGroupId(v string) *DescribeGroupInput

SetGroupId sets the GroupId field's value.

func (*DescribeGroupInput) SetIdentityStoreId

func (s *DescribeGroupInput) SetIdentityStoreId(v string) *DescribeGroupInput

SetIdentityStoreId sets the IdentityStoreId field's value.

func (DescribeGroupInput) String

func (s DescribeGroupInput) String() string

String returns the string representation

func (*DescribeGroupInput) Validate

func (s *DescribeGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGroupOutput

type DescribeGroupOutput struct {

    // Contains 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. The characters <>;:% are excluded. 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 required field
    DisplayName *string `min:"1" type:"string" required:"true"`

    // The identifier for a group in the identity store.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeGroupOutput) GoString

func (s DescribeGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeGroupOutput) SetDisplayName

func (s *DescribeGroupOutput) SetDisplayName(v string) *DescribeGroupOutput

SetDisplayName sets the DisplayName field's value.

func (*DescribeGroupOutput) SetGroupId

func (s *DescribeGroupOutput) SetGroupId(v string) *DescribeGroupOutput

SetGroupId sets the GroupId field's value.

func (DescribeGroupOutput) String

func (s DescribeGroupOutput) String() string

String returns the string representation

type DescribeUserInput

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 number 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 (DescribeUserInput) GoString

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetIdentityStoreId

func (s *DescribeUserInput) SetIdentityStoreId(v string) *DescribeUserInput

SetIdentityStoreId sets the IdentityStoreId field's value.

func (*DescribeUserInput) SetUserId

func (s *DescribeUserInput) SetUserId(v string) *DescribeUserInput

SetUserId sets the UserId field's value.

func (DescribeUserInput) String

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput

type DescribeUserOutput struct {

    // The identifier for a user in the identity store.
    //
    // UserId is a required field
    UserId *string `min:"1" type:"string" required:"true"`

    // Contains the user’s user name value. The length limit is 128 characters.
    // This value can consist of letters, accented characters, symbols, numbers,
    // and punctuation. The characters <>;:% are excluded. 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 required field
    UserName *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DescribeUserOutput) GoString

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetUserId

func (s *DescribeUserOutput) SetUserId(v string) *DescribeUserOutput

SetUserId sets the UserId field's value.

func (*DescribeUserOutput) SetUserName

func (s *DescribeUserOutput) SetUserName(v string) *DescribeUserOutput

SetUserName sets the UserName field's value.

func (DescribeUserOutput) String

func (s DescribeUserOutput) String() string

String returns the string representation

type Filter

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 required field
    AttributeValue *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

A query filter used by ListUsers and ListGroup. This filter object provides the attribute name and attribute value to search users or groups.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetAttributePath

func (s *Filter) SetAttributePath(v string) *Filter

SetAttributePath sets the AttributePath field's value.

func (*Filter) SetAttributeValue

func (s *Filter) SetAttributeValue(v string) *Filter

SetAttributeValue sets the AttributeValue field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate

func (s *Filter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Group

type Group struct {

    // Contains 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. The characters <>;:% are excluded. 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 required field
    DisplayName *string `min:"1" type:"string" required:"true"`

    // The identifier for a group in the identity store.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

A group object, which contains a specified group’s metadata and attributes.

func (Group) GoString

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetDisplayName

func (s *Group) SetDisplayName(v string) *Group

SetDisplayName sets the DisplayName field's value.

func (*Group) SetGroupId

func (s *Group) SetGroupId(v string) *Group

SetGroupId sets the GroupId field's value.

func (Group) String

func (s Group) String() string

String returns the string representation

type IdentityStore

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

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 (*IdentityStore) DescribeGroup

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.

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.

* ValidationException
The request failed because it contains a syntax error.

* AccessDeniedException
You do not have sufficient access to perform this action.

* ThrottlingException
Indicates that the principal has crossed the throttling limits of the API
operations.

* InternalServerException
The request processing has failed because of an unknown error, exception
or failure with an internal server.

See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroup

func (*IdentityStore) DescribeGroupRequest

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 (*IdentityStore) DescribeGroupWithContext

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 (*IdentityStore) DescribeUser

func (c *IdentityStore) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for AWS SSO Identity Store.

Retrieves the user metadata and attributes from UserId in an 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 DescribeUser for usage and error information.

Returned Error Types:

* ResourceNotFoundException
Indicates that a requested resource is not found.

* ValidationException
The request failed because it contains a syntax error.

* AccessDeniedException
You do not have sufficient access to perform this action.

* ThrottlingException
Indicates that the principal has crossed the throttling limits of the API
operations.

* InternalServerException
The request processing has failed because of an unknown error, exception
or failure with an internal server.

See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUser

func (*IdentityStore) DescribeUserRequest

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 (*IdentityStore) DescribeUserWithContext

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 (*IdentityStore) ListGroups

func (c *IdentityStore) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for AWS SSO Identity Store.

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

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:

* ValidationException
The request failed because it contains a syntax error.

* AccessDeniedException
You do not have sufficient access to perform this action.

* ResourceNotFoundException
Indicates that a requested resource is not found.

* ThrottlingException
Indicates that the principal has crossed the throttling limits of the API
operations.

* InternalServerException
The request processing has failed because of an unknown error, exception
or failure with an internal server.

See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroups

func (*IdentityStore) ListGroupsPages

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 (*IdentityStore) ListGroupsPagesWithContext

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 (*IdentityStore) ListGroupsRequest

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 (*IdentityStore) ListGroupsWithContext

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 (*IdentityStore) ListUsers

func (c *IdentityStore) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for AWS SSO Identity Store.

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

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:

* ValidationException
The request failed because it contains a syntax error.

* AccessDeniedException
You do not have sufficient access to perform this action.

* ResourceNotFoundException
Indicates that a requested resource is not found.

* ThrottlingException
Indicates that the principal has crossed the throttling limits of the API
operations.

* InternalServerException
The request processing has failed because of an unknown error, exception
or failure with an internal server.

See also, https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsers

func (*IdentityStore) ListUsersPages

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 (*IdentityStore) ListUsersPagesWithContext

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 (*IdentityStore) ListUsersRequest

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 (*IdentityStore) ListUsersWithContext

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.

type InternalServerException

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" 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 `type:"string"`
    // contains filtered or unexported fields
}

The request processing has failed because of an unknown error, exception or failure with an internal server.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation

type ListGroupsInput

type ListGroupsInput struct {

    // A list of Filter objects, which is used in the ListUsers and ListGroups request.
    Filters []*Filter `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 number 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 request 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 (ListGroupsInput) GoString

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (*ListGroupsInput) SetFilters

func (s *ListGroupsInput) SetFilters(v []*Filter) *ListGroupsInput

SetFilters sets the Filters field's value.

func (*ListGroupsInput) SetIdentityStoreId

func (s *ListGroupsInput) SetIdentityStoreId(v string) *ListGroupsInput

SetIdentityStoreId sets the IdentityStoreId field's value.

func (*ListGroupsInput) SetMaxResults

func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNextToken

func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput

SetNextToken sets the NextToken field's value.

func (ListGroupsInput) String

func (s ListGroupsInput) String() string

String returns the string representation

func (*ListGroupsInput) Validate

func (s *ListGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupsOutput

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 (ListGroupsOutput) GoString

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (*ListGroupsOutput) SetGroups

func (s *ListGroupsOutput) SetGroups(v []*Group) *ListGroupsOutput

SetGroups sets the Groups field's value.

func (*ListGroupsOutput) SetNextToken

func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOutput) String

func (s ListGroupsOutput) String() string

String returns the string representation

type ListUsersInput

type ListUsersInput struct {

    // A list of Filter objects, which is used in the ListUsers and ListGroups request.
    Filters []*Filter `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 number 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 request 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 (ListUsersInput) GoString

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetFilters

func (s *ListUsersInput) SetFilters(v []*Filter) *ListUsersInput

SetFilters sets the Filters field's value.

func (*ListUsersInput) SetIdentityStoreId

func (s *ListUsersInput) SetIdentityStoreId(v string) *ListUsersInput

SetIdentityStoreId sets the IdentityStoreId field's value.

func (*ListUsersInput) SetMaxResults

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (ListUsersInput) String

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUsersOutput

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 (ListUsersOutput) GoString

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetUsers

func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput

SetUsers sets the Users field's value.

func (ListUsersOutput) String

func (s ListUsersOutput) String() string

String returns the string representation

type ResourceNotFoundException

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" 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 `type:"string"`

    // The identifier for a resource in the identity store, which 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"`

    // The type of resource in the Identity Store service, which is an enum object.
    // 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 (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

type ThrottlingException

type ThrottlingException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" 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 `type:"string"`
    // contains filtered or unexported fields
}

Indicates that the principal has crossed the throttling limits of the API operations.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation

type User

type User struct {

    // The identifier for a user in the identity store.
    //
    // UserId is a required field
    UserId *string `min:"1" type:"string" required:"true"`

    // Contains the user’s user name value. The length limit is 128 characters.
    // This value can consist of letters, accented characters, symbols, numbers,
    // and punctuation. The characters <>;:% are excluded. 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 required field
    UserName *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

A user object, which contains a specified user’s metadata and attributes.

func (User) GoString

func (s User) GoString() string

GoString returns the string representation

func (*User) SetUserId

func (s *User) SetUserId(v string) *User

SetUserId sets the UserId field's value.

func (*User) SetUserName

func (s *User) SetUserName(v string) *User

SetUserName sets the UserName field's value.

func (User) String

func (s User) String() string

String returns the string representation

type ValidationException

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" 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 `type:"string"`
    // contains filtered or unexported fields
}

The request failed because it contains a syntax error.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation