types

package
v1.23.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 15

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type Address added in v1.15.0

type Address struct {

	// The country of the address.
	Country *string

	// A string containing a formatted version of the address for display.
	Formatted *string

	// A string of the address locality.
	Locality *string

	// The postal code of the address.
	PostalCode *string

	// A Boolean value representing whether this is the primary address for the
	// associated resource.
	Primary bool

	// The region of the address.
	Region *string

	// The street of the address.
	StreetAddress *string

	// A string representing the type of address. For example, "Home."
	Type *string
	// contains filtered or unexported fields
}

The address associated with the specified user.

type AlternateIdentifier added in v1.15.0

type AlternateIdentifier interface {
	// contains filtered or unexported methods
}

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.

The following types satisfy this interface:

AlternateIdentifierMemberExternalId
AlternateIdentifierMemberUniqueAttribute
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/identitystore/types"
)

func main() {
	var union types.AlternateIdentifier
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AlternateIdentifierMemberExternalId:
		_ = v.Value // Value is types.ExternalId

	case *types.AlternateIdentifierMemberUniqueAttribute:
		_ = v.Value // Value is types.UniqueAttribute

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type AlternateIdentifierMemberExternalId added in v1.15.0

type AlternateIdentifierMemberExternalId struct {
	Value ExternalId
	// contains filtered or unexported fields
}

The identifier issued to this resource by an external identity provider.

type AlternateIdentifierMemberUniqueAttribute added in v1.15.0

type AlternateIdentifierMemberUniqueAttribute struct {
	Value UniqueAttribute
	// contains filtered or unexported fields
}

An entity attribute that's unique to a specific entity.

type AttributeOperation added in v1.15.0

type AttributeOperation struct {

	// A string representation of the path to a given attribute or sub-attribute.
	// Supports JMESPath.
	//
	// This member is required.
	AttributePath *string

	// The value of the attribute. This is a Document type. This type is not supported
	// by Java V1, Go V1, and older versions of the CLI.
	AttributeValue document.Interface
	// contains filtered or unexported fields
}

An operation that applies to the requested group. This operation might add, replace, or remove an attribute.

type ConflictException added in v1.15.0

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	Reason    ConflictExceptionReason
	// 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 (*ConflictException) Error added in v1.15.0

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.15.0

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.15.0

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v1.15.0

func (e *ConflictException) ErrorMessage() string

type ConflictExceptionReason added in v1.15.0

type ConflictExceptionReason string
const (
	ConflictExceptionReasonUniquenessConstraintViolation ConflictExceptionReason = "UNIQUENESS_CONSTRAINT_VIOLATION"
	ConflictExceptionReasonConcurrentModification        ConflictExceptionReason = "CONCURRENT_MODIFICATION"
)

Enum values for ConflictExceptionReason

func (ConflictExceptionReason) Values added in v1.15.0

Values returns all known values for ConflictExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Email added in v1.15.0

type Email struct {

	// A Boolean value representing whether this is the primary email address for the
	// associated resource.
	Primary bool

	// A string representing the type of address. For example, "Work."
	Type *string

	// A string containing an email address. For example, "johndoe@amazon.com."
	Value *string
	// contains filtered or unexported fields
}

The email address associated with the user.

type ExternalId added in v1.15.0

type ExternalId struct {

	// The identifier issued to this resource by an external identity provider.
	//
	// This member is required.
	Id *string

	// The issuer for an external identifier.
	//
	// This member is required.
	Issuer *string
	// contains filtered or unexported fields
}

The identifier issued to this resource by an external identity provider.

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.
	//
	// This member is required.
	AttributePath *string

	// Represents the data for an attribute. Each attribute value is described as a
	// name-value pair.
	//
	// This member is required.
	AttributeValue *string
	// 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.

type Group

type Group struct {

	// The identifier for a group in the identity store.
	//
	// This member is required.
	GroupId *string

	// The globally unique identifier for the identity store.
	//
	// This member is required.
	IdentityStoreId *string

	// A string containing a description of the specified group.
	Description *string

	// 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 *string

	// A list of ExternalId objects that contains the identifiers issued to this
	// resource by an external identity provider.
	ExternalIds []ExternalId
	// contains filtered or unexported fields
}

A group object that contains the metadata and attributes for a specified group.

type GroupMembership added in v1.15.0

type GroupMembership struct {

	// The globally unique identifier for the identity store.
	//
	// This member is required.
	IdentityStoreId *string

	// The identifier for a group in the identity store.
	GroupId *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

	// The identifier for a GroupMembership object in an identity store.
	MembershipId *string
	// contains filtered or unexported fields
}

Contains the identifiers for a group, a group member, and a GroupMembership object in the identity store.

type GroupMembershipExistenceResult added in v1.15.0

type GroupMembershipExistenceResult struct {

	// The identifier for a group in the identity store.
	GroupId *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

	// Indicates whether a membership relation exists or not.
	MembershipExists bool
	// contains filtered or unexported fields
}

Indicates whether a resource is a member of a group in the identity store.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId         *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type MemberId added in v1.15.0

type MemberId interface {
	// contains filtered or unexported methods
}

An object containing the identifier of a group member.

The following types satisfy this interface:

MemberIdMemberUserId
Example (OutputUsage)
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/identitystore/types"
)

func main() {
	var union types.MemberId
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MemberIdMemberUserId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}
Output:

type MemberIdMemberUserId added in v1.15.0

type MemberIdMemberUserId struct {
	Value string
	// contains filtered or unexported fields
}

An object containing the identifiers of resources that can be members.

type Name added in v1.15.0

type Name struct {

	// The family name of the user.
	FamilyName *string

	// A string containing a formatted version of the name for display.
	Formatted *string

	// The given name of the user.
	GivenName *string

	// The honorific prefix of the user. For example, "Dr."
	HonorificPrefix *string

	// The honorific suffix of the user. For example, "M.D."
	HonorificSuffix *string

	// The middle name of the user.
	MiddleName *string
	// contains filtered or unexported fields
}

The full name of the user.

type PhoneNumber added in v1.15.0

type PhoneNumber struct {

	// A Boolean value representing whether this is the primary phone number for the
	// associated resource.
	Primary bool

	// A string representing the type of a phone number. For example, "Mobile."
	Type *string

	// A string containing a phone number. For example, "8675309" or "+1 (800)
	// 123-4567".
	Value *string
	// contains filtered or unexported fields
}

The phone number associated with the user.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ResourceType
	ResourceId   *string
	RequestId    *string
	// contains filtered or unexported fields
}

Indicates that a requested resource is not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType

type ResourceType string
const (
	ResourceTypeGroup           ResourceType = "GROUP"
	ResourceTypeUser            ResourceType = "USER"
	ResourceTypeIdentityStore   ResourceType = "IDENTITY_STORE"
	ResourceTypeGroupMembership ResourceType = "GROUP_MEMBERSHIP"
)

Enum values for ResourceType

func (ResourceType) Values

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException added in v1.15.0

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *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 (*ServiceQuotaExceededException) Error added in v1.15.0

func (*ServiceQuotaExceededException) ErrorCode added in v1.15.0

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v1.15.0

func (*ServiceQuotaExceededException) ErrorMessage added in v1.15.0

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId         *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

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

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type UniqueAttribute added in v1.15.0

type UniqueAttribute struct {

	// A string representation of the path to a given attribute or sub-attribute.
	// Supports JMESPath.
	//
	// This member is required.
	AttributePath *string

	// The value of the attribute. This is a Document type. This type is not supported
	// by Java V1, Go V1, and older versions of the CLI.
	//
	// This member is required.
	AttributeValue document.Interface
	// contains filtered or unexported fields
}

An entity attribute that's unique to a specific entity.

type UnknownUnionMember added in v1.15.0

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type User

type User struct {

	// The globally unique identifier for the identity store.
	//
	// This member is required.
	IdentityStoreId *string

	// The identifier for a user in the identity store.
	//
	// This member is required.
	UserId *string

	// A list of Address objects containing addresses associated with the user.
	Addresses []Address

	// A string containing the name of the user that is formatted for display when the
	// user is referenced. For example, "John Doe."
	DisplayName *string

	// A list of Email objects containing email addresses associated with the user.
	Emails []Email

	// A list of ExternalId objects that contains the identifiers issued to this
	// resource by an external identity provider.
	ExternalIds []ExternalId

	// A string containing the geographical region or location of the user.
	Locale *string

	// An object containing the name of the user.
	Name *Name

	// A string containing an alternate name for the user.
	NickName *string

	// A list of PhoneNumber objects containing phone numbers associated with the user.
	PhoneNumbers []PhoneNumber

	// A string containing the preferred language of the user. For example, "American
	// English" or "en-us."
	PreferredLanguage *string

	// A string containing a URL that might be associated with the user.
	ProfileUrl *string

	// A string containing the time zone of the user.
	Timezone *string

	// A string containing the title of the user. Possible values are left
	// unspecified. The value can vary based on your specific use case.
	Title *string

	// 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 *string

	// A string indicating the type of user. Possible values are left unspecified. The
	// value can vary based on your specific use case.
	UserType *string
	// contains filtered or unexported fields
}

A user object that contains the metadata and attributes for a specified user.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	RequestId *string
	// contains filtered or unexported fields
}

The request failed because it contains a syntax error.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL