directoryservice

package module
v1.30.9 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 43 Imported by: 28

Documentation

Overview

Package directoryservice provides the API client, operations, and parameter types for AWS Directory Service.

Directory Service

Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Serviceand the Directory Service Administration Guide.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

Index

Constants

View Source 
const ServiceAPIVersion = "2015-04-16"
View Source 
const ServiceID = "Directory Service"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.18.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.21.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.21.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptSharedDirectoryInput 

type AcceptSharedDirectoryInput struct {

	// Identifier of the shared directory in the directory consumer account. This
	// identifier is different for each directory owner account.
	//
	// This member is required.
	SharedDirectoryId *string
	// contains filtered or unexported fields
}

type AcceptSharedDirectoryOutput 

type AcceptSharedDirectoryOutput struct {

	// The shared directory in the directory consumer account.
	SharedDirectory *types.SharedDirectory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddIpRoutesInput 

type AddIpRoutesInput struct {

	// Identifier (ID) of the directory to which to add the address block.
	//
	// This member is required.
	DirectoryId *string

	// IP address blocks, using CIDR format, of the traffic to route. This is often
	// the IP address block of the DNS server used for your self-managed domain.
	//
	// This member is required.
	IpRoutes []types.IpRoute

	// If set to true, updates the inbound and outbound rules of the security group
	// that has the description: "Amazon Web Services created security group for
	// directory ID directory controllers." Following are the new rules:
	//
	// Inbound:
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: Managed Microsoft
	//   AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: Managed
	//   Microsoft AD VPC IPv4 CIDR
	//
	//   - Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: Managed
	//   Microsoft AD VPC IPv4 CIDR
	//
	//   - Type: DNS (UDP), Protocol: UDP, Range: 53, Source: Managed Microsoft AD VPC
	//   IPv4 CIDR
	//
	//   - Type: DNS (TCP), Protocol: TCP, Range: 53, Source: Managed Microsoft AD VPC
	//   IPv4 CIDR
	//
	//   - Type: LDAP, Protocol: TCP, Range: 389, Source: Managed Microsoft AD VPC
	//   IPv4 CIDR
	//
	//   - Type: All ICMP, Protocol: All, Range: N/A, Source: Managed Microsoft AD VPC
	//   IPv4 CIDR
	//
	// Outbound:
	//
	//   - Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
	//
	// These security rules impact an internal network interface that is not exposed
	// publicly.
	UpdateSecurityGroupForDirectoryControllers bool
	// contains filtered or unexported fields
}

type AddIpRoutesOutput 

type AddIpRoutesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddRegionInput added in v0.30.0 

type AddRegionInput struct {

	// The identifier of the directory to which you want to add Region replication.
	//
	// This member is required.
	DirectoryId *string

	// The name of the Region where you want to add domain controllers for
	// replication. For example, us-east-1 .
	//
	// This member is required.
	RegionName *string

	// Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
	//
	// This member is required.
	VPCSettings *types.DirectoryVpcSettings
	// contains filtered or unexported fields
}

type AddRegionOutput added in v0.30.0 

type AddRegionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddTagsToResourceInput 

type AddTagsToResourceInput struct {

	// Identifier (ID) for the directory to which to add the tag.
	//
	// This member is required.
	ResourceId *string

	// The tags to be assigned to the directory.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type AddTagsToResourceOutput 

type AddTagsToResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.21.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.21.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelSchemaExtensionInput 

type CancelSchemaExtensionInput struct {

	// The identifier of the directory whose schema extension will be canceled.
	//
	// This member is required.
	DirectoryId *string

	// The identifier of the schema extension that will be canceled.
	//
	// This member is required.
	SchemaExtensionId *string
	// contains filtered or unexported fields
}

type CancelSchemaExtensionOutput 

type CancelSchemaExtensionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Directory Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptSharedDirectory 

func (c *Client) AcceptSharedDirectory(ctx context.Context, params *AcceptSharedDirectoryInput, optFns ...func(*Options)) (*AcceptSharedDirectoryOutput, error)

Accepts a directory sharing request that was sent from the directory owner account.

func (*Client) AddIpRoutes 

func (c *Client) AddIpRoutes(ctx context.Context, params *AddIpRoutesInput, optFns ...func(*Options)) (*AddIpRoutesOutput, error)

If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

func (*Client) AddRegion added in v0.30.0 

func (c *Client) AddRegion(ctx context.Context, params *AddRegionInput, optFns ...func(*Options)) (*AddRegionOutput, error)

Adds two domain controllers in the specified Region for the specified directory.

func (*Client) AddTagsToResource 

func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

func (*Client) CancelSchemaExtension 

func (c *Client) CancelSchemaExtension(ctx context.Context, params *CancelSchemaExtensionInput, optFns ...func(*Options)) (*CancelSchemaExtensionOutput, error)

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing , CreatingSnapshot , and UpdatingSchema .

func (*Client) ConnectDirectory 

func (c *Client) ConnectDirectory(ctx context.Context, params *ConnectDirectoryInput, optFns ...func(*Options)) (*ConnectDirectoryOutput, error)

Creates an AD Connector to connect to a self-managed directory.

Before you call ConnectDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

func (*Client) CreateAlias 

func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error)

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://.awsapps.com .

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

func (*Client) CreateComputer 

func (c *Client) CreateComputer(ctx context.Context, params *CreateComputerInput, optFns ...func(*Options)) (*CreateComputerOutput, error)

Creates an Active Directory computer object in the specified directory.

func (*Client) CreateConditionalForwarder 

func (c *Client) CreateConditionalForwarder(ctx context.Context, params *CreateConditionalForwarderInput, optFns ...func(*Options)) (*CreateConditionalForwarderOutput, error)

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

func (*Client) CreateDirectory 

func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error)

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.

Before you call CreateDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

func (*Client) CreateLogSubscription 

func (c *Client) CreateLogSubscription(ctx context.Context, params *CreateLogSubscriptionInput, optFns ...func(*Options)) (*CreateLogSubscriptionOutput, error)

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

func (*Client) CreateMicrosoftAD 

func (c *Client) CreateMicrosoftAD(ctx context.Context, params *CreateMicrosoftADInput, optFns ...func(*Options)) (*CreateMicrosoftADOutput, error)

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft ADin the Directory Service Admin Guide.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

func (*Client) CreateSnapshot 

func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error)

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

You cannot take snapshots of AD Connector directories.

func (*Client) CreateTrust 

func (c *Client) CreateTrust(ctx context.Context, params *CreateTrustInput, optFns ...func(*Options)) (*CreateTrustOutput, error)

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

func (*Client) DeleteConditionalForwarder 

func (c *Client) DeleteConditionalForwarder(ctx context.Context, params *DeleteConditionalForwarderInput, optFns ...func(*Options)) (*DeleteConditionalForwarderOutput, error)

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

func (*Client) DeleteDirectory 

func (c *Client) DeleteDirectory(ctx context.Context, params *DeleteDirectoryInput, optFns ...func(*Options)) (*DeleteDirectoryOutput, error)

Deletes an Directory Service directory.

Before you call DeleteDirectory , ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

func (*Client) DeleteLogSubscription 

func (c *Client) DeleteLogSubscription(ctx context.Context, params *DeleteLogSubscriptionInput, optFns ...func(*Options)) (*DeleteLogSubscriptionOutput, error)

Deletes the specified log subscription.

func (*Client) DeleteSnapshot 

func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error)

Deletes a directory snapshot.

func (*Client) DeleteTrust 

func (c *Client) DeleteTrust(ctx context.Context, params *DeleteTrustInput, optFns ...func(*Options)) (*DeleteTrustOutput, error)

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.

func (*Client) DeregisterCertificate 

func (c *Client) DeregisterCertificate(ctx context.Context, params *DeregisterCertificateInput, optFns ...func(*Options)) (*DeregisterCertificateOutput, error)

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

func (*Client) DeregisterEventTopic 

func (c *Client) DeregisterEventTopic(ctx context.Context, params *DeregisterEventTopicInput, optFns ...func(*Options)) (*DeregisterEventTopicOutput, error)

Removes the specified directory as a publisher to the specified Amazon SNS topic.

func (*Client) DescribeCertificate 

func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error)

Displays information about the certificate registered for secure LDAP or client certificate authentication.

func (*Client) DescribeClientAuthenticationSettings added in v1.4.0 

func (c *Client) DescribeClientAuthenticationSettings(ctx context.Context, params *DescribeClientAuthenticationSettingsInput, optFns ...func(*Options)) (*DescribeClientAuthenticationSettingsOutput, error)

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

func (*Client) DescribeConditionalForwarders 

func (c *Client) DescribeConditionalForwarders(ctx context.Context, params *DescribeConditionalForwardersInput, optFns ...func(*Options)) (*DescribeConditionalForwardersOutput, error)

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

func (*Client) DescribeDirectories 

func (c *Client) DescribeDirectories(ctx context.Context, params *DescribeDirectoriesInput, optFns ...func(*Options)) (*DescribeDirectoriesOutput, error)

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectoriesto retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

func (*Client) DescribeDirectoryDataAccess added in v1.28.0 

func (c *Client) DescribeDirectoryDataAccess(ctx context.Context, params *DescribeDirectoryDataAccessInput, optFns ...func(*Options)) (*DescribeDirectoryDataAccessOutput, error)

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

func (*Client) DescribeDomainControllers 

func (c *Client) DescribeDomainControllers(ctx context.Context, params *DescribeDomainControllersInput, optFns ...func(*Options)) (*DescribeDomainControllersOutput, error)

Provides information about any domain controllers in your directory.

func (*Client) DescribeEventTopics 

func (c *Client) DescribeEventTopics(ctx context.Context, params *DescribeEventTopicsInput, optFns ...func(*Options)) (*DescribeEventTopicsOutput, error)

Obtains information about which Amazon SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

func (*Client) DescribeLDAPSSettings 

func (c *Client) DescribeLDAPSSettings(ctx context.Context, params *DescribeLDAPSSettingsInput, optFns ...func(*Options)) (*DescribeLDAPSSettingsOutput, error)

Describes the status of LDAP security for the specified directory.

func (*Client) DescribeRegions added in v0.30.0 

func (c *Client) DescribeRegions(ctx context.Context, params *DescribeRegionsInput, optFns ...func(*Options)) (*DescribeRegionsOutput, error)

Provides information about the Regions that are configured for multi-Region replication.

func (*Client) DescribeSettings added in v1.14.0 

func (c *Client) DescribeSettings(ctx context.Context, params *DescribeSettingsInput, optFns ...func(*Options)) (*DescribeSettingsOutput, error)

Retrieves information about the configurable settings for the specified directory.

func (*Client) DescribeSharedDirectories 

func (c *Client) DescribeSharedDirectories(ctx context.Context, params *DescribeSharedDirectoriesInput, optFns ...func(*Options)) (*DescribeSharedDirectoriesOutput, error)

Returns the shared directories in your account.

func (*Client) DescribeSnapshots 

func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error)

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshotsto retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

func (*Client) DescribeTrusts 

func (c *Client) DescribeTrusts(ctx context.Context, params *DescribeTrustsInput, optFns ...func(*Options)) (*DescribeTrustsOutput, error)

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

func (*Client) DescribeUpdateDirectory added in v1.15.0 

func (c *Client) DescribeUpdateDirectory(ctx context.Context, params *DescribeUpdateDirectoryInput, optFns ...func(*Options)) (*DescribeUpdateDirectoryOutput, error)

Describes the updates of a directory for a particular update type.

func (*Client) DisableClientAuthentication added in v0.31.0 

func (c *Client) DisableClientAuthentication(ctx context.Context, params *DisableClientAuthenticationInput, optFns ...func(*Options)) (*DisableClientAuthenticationOutput, error)

Disables alternative client authentication methods for the specified directory.

func (*Client) DisableDirectoryDataAccess added in v1.28.0 

func (c *Client) DisableDirectoryDataAccess(ctx context.Context, params *DisableDirectoryDataAccessInput, optFns ...func(*Options)) (*DisableDirectoryDataAccessOutput, error)

Deactivates access to directory data via the Directory Service Data API for the specified directory.

func (*Client) DisableLDAPS 

func (c *Client) DisableLDAPS(ctx context.Context, params *DisableLDAPSInput, optFns ...func(*Options)) (*DisableLDAPSOutput, error)

Deactivates LDAP secure calls for the specified directory.

func (*Client) DisableRadius 

func (c *Client) DisableRadius(ctx context.Context, params *DisableRadiusInput, optFns ...func(*Options)) (*DisableRadiusOutput, error)

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

func (*Client) DisableSso 

func (c *Client) DisableSso(ctx context.Context, params *DisableSsoInput, optFns ...func(*Options)) (*DisableSsoOutput, error)

Disables single-sign on for a directory.

func (*Client) EnableClientAuthentication added in v0.31.0 

func (c *Client) EnableClientAuthentication(ctx context.Context, params *EnableClientAuthenticationInput, optFns ...func(*Options)) (*EnableClientAuthenticationOutput, error)

Enables alternative client authentication methods for the specified directory.

func (*Client) EnableDirectoryDataAccess added in v1.28.0 

func (c *Client) EnableDirectoryDataAccess(ctx context.Context, params *EnableDirectoryDataAccessInput, optFns ...func(*Options)) (*EnableDirectoryDataAccessOutput, error)

Enables access to directory data via the Directory Service Data API for the specified directory.

func (*Client) EnableLDAPS 

func (c *Client) EnableLDAPS(ctx context.Context, params *EnableLDAPSInput, optFns ...func(*Options)) (*EnableLDAPSOutput, error)

Activates the switch for the specific directory to always use LDAP secure calls.

func (*Client) EnableRadius 

func (c *Client) EnableRadius(ctx context.Context, params *EnableRadiusInput, optFns ...func(*Options)) (*EnableRadiusOutput, error)

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

func (*Client) EnableSso 

func (c *Client) EnableSso(ctx context.Context, params *EnableSsoInput, optFns ...func(*Options)) (*EnableSsoOutput, error)

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.

func (*Client) GetDirectoryLimits 

func (c *Client) GetDirectoryLimits(ctx context.Context, params *GetDirectoryLimitsInput, optFns ...func(*Options)) (*GetDirectoryLimitsOutput, error)

Obtains directory limit information for the current Region.

func (*Client) GetSnapshotLimits 

func (c *Client) GetSnapshotLimits(ctx context.Context, params *GetSnapshotLimitsInput, optFns ...func(*Options)) (*GetSnapshotLimitsOutput, error)

Obtains the manual snapshot limits for a directory.

func (*Client) ListCertificates 

func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error)

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

func (*Client) ListIpRoutes 

func (c *Client) ListIpRoutes(ctx context.Context, params *ListIpRoutesInput, optFns ...func(*Options)) (*ListIpRoutesOutput, error)

Lists the address blocks that you have added to a directory.

func (*Client) ListLogSubscriptions 

func (c *Client) ListLogSubscriptions(ctx context.Context, params *ListLogSubscriptionsInput, optFns ...func(*Options)) (*ListLogSubscriptionsOutput, error)

Lists the active log subscriptions for the Amazon Web Services account.

func (*Client) ListSchemaExtensions 

func (c *Client) ListSchemaExtensions(ctx context.Context, params *ListSchemaExtensionsInput, optFns ...func(*Options)) (*ListSchemaExtensionsOutput, error)

Lists all schema extensions applied to a Microsoft AD Directory.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags on a directory.

func (*Client) Options added in v1.22.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) RegisterCertificate 

func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertificateInput, optFns ...func(*Options)) (*RegisterCertificateOutput, error)

Registers a certificate for a secure LDAP or client certificate authentication.

func (*Client) RegisterEventTopic 

func (c *Client) RegisterEventTopic(ctx context.Context, params *RegisterEventTopicInput, optFns ...func(*Options)) (*RegisterEventTopicOutput, error)

Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

func (*Client) RejectSharedDirectory 

func (c *Client) RejectSharedDirectory(ctx context.Context, params *RejectSharedDirectoryInput, optFns ...func(*Options)) (*RejectSharedDirectoryOutput, error)

Rejects a directory sharing request that was sent from the directory owner account.

func (*Client) RemoveIpRoutes 

func (c *Client) RemoveIpRoutes(ctx context.Context, params *RemoveIpRoutesInput, optFns ...func(*Options)) (*RemoveIpRoutesOutput, error)

Removes IP address blocks from a directory.

func (*Client) RemoveRegion added in v0.30.0 

func (c *Client) RemoveRegion(ctx context.Context, params *RemoveRegionInput, optFns ...func(*Options)) (*RemoveRegionOutput, error)

Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.

func (*Client) RemoveTagsFromResource 

func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)

Removes tags from a directory.

func (*Client) ResetUserPassword 

func (c *Client) ResetUserPassword(ctx context.Context, params *ResetUserPasswordInput, optFns ...func(*Options)) (*ResetUserPasswordOutput, error)

Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

  • For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Createdin the Directory Service Administration Guide.

func (*Client) RestoreFromSnapshot 

func (c *Client) RestoreFromSnapshot(ctx context.Context, params *RestoreFromSnapshotInput, optFns ...func(*Options)) (*RestoreFromSnapshotOutput, error)

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectoriesoperation with the directory identifier. When the DirectoryDescription.Stage value changes to Active , the restore operation is complete.

func (*Client) ShareDirectory 

func (c *Client) ShareDirectory(ctx context.Context, params *ShareDirectoryInput, optFns ...func(*Options)) (*ShareDirectoryOutput, error)

Shares a specified directory ( DirectoryId ) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization ( ORGANIZATIONS ). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization ( HANDSHAKE ).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

func (*Client) StartSchemaExtension 

func (c *Client) StartSchemaExtension(ctx context.Context, params *StartSchemaExtensionInput, optFns ...func(*Options)) (*StartSchemaExtensionOutput, error)

Applies a schema extension to a Microsoft AD directory.

func (*Client) UnshareDirectory 

func (c *Client) UnshareDirectory(ctx context.Context, params *UnshareDirectoryInput, optFns ...func(*Options)) (*UnshareDirectoryOutput, error)

Stops the directory sharing between the directory owner and consumer accounts.

func (*Client) UpdateConditionalForwarder 

func (c *Client) UpdateConditionalForwarder(ctx context.Context, params *UpdateConditionalForwarderInput, optFns ...func(*Options)) (*UpdateConditionalForwarderOutput, error)

Updates a conditional forwarder that has been set up for your Amazon Web Services directory.

func (*Client) UpdateDirectorySetup added in v1.15.0 

func (c *Client) UpdateDirectorySetup(ctx context.Context, params *UpdateDirectorySetupInput, optFns ...func(*Options)) (*UpdateDirectorySetupOutput, error)

Updates the directory for a particular update type.

func (*Client) UpdateNumberOfDomainControllers 

func (c *Client) UpdateNumberOfDomainControllers(ctx context.Context, params *UpdateNumberOfDomainControllersInput, optFns ...func(*Options)) (*UpdateNumberOfDomainControllersOutput, error)

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

func (*Client) UpdateRadius 

func (c *Client) UpdateRadius(ctx context.Context, params *UpdateRadiusInput, optFns ...func(*Options)) (*UpdateRadiusOutput, error)

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

func (*Client) UpdateSettings added in v1.14.0 

func (c *Client) UpdateSettings(ctx context.Context, params *UpdateSettingsInput, optFns ...func(*Options)) (*UpdateSettingsOutput, error)

Updates the configurable settings for the specified directory.

func (*Client) UpdateTrust 

func (c *Client) UpdateTrust(ctx context.Context, params *UpdateTrustInput, optFns ...func(*Options)) (*UpdateTrustOutput, error)

Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.

func (*Client) VerifyTrust 

func (c *Client) VerifyTrust(ctx context.Context, params *VerifyTrustInput, optFns ...func(*Options)) (*VerifyTrustOutput, error)

Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.

type ConnectDirectoryInput 

type ConnectDirectoryInput struct {

	// A DirectoryConnectSettings object that contains additional information for the operation.
	//
	// This member is required.
	ConnectSettings *types.DirectoryConnectSettings

	// The fully qualified name of your self-managed directory, such as
	// corp.example.com .
	//
	// This member is required.
	Name *string

	// The password for your self-managed user account.
	//
	// This member is required.
	Password *string

	// The size of the directory.
	//
	// This member is required.
	Size types.DirectorySize

	// A description for the directory.
	Description *string

	// The NetBIOS name of your self-managed directory, such as CORP .
	ShortName *string

	// The tags to be assigned to AD Connector.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Contains the inputs for the ConnectDirectory operation.

type ConnectDirectoryOutput 

type ConnectDirectoryOutput struct {

	// The identifier of the new directory.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the ConnectDirectory operation.

type CreateAliasInput 

type CreateAliasInput struct {

	// The requested alias.
	//
	// The alias must be unique amongst all aliases in Amazon Web Services. This
	// operation throws an EntityAlreadyExistsException error if the alias already
	// exists.
	//
	// This member is required.
	Alias *string

	// The identifier of the directory for which to create the alias.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

Contains the inputs for the CreateAlias operation.

type CreateAliasOutput 

type CreateAliasOutput struct {

	// The alias for the directory.
	Alias *string

	// The identifier of the directory.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the CreateAlias operation.

type CreateComputerInput 

type CreateComputerInput struct {

	// The name of the computer account.
	//
	// This member is required.
	ComputerName *string

	// The identifier of the directory in which to create the computer account.
	//
	// This member is required.
	DirectoryId *string

	// A one-time password that is used to join the computer to the directory. You
	// should generate a random, strong password to use for this parameter.
	//
	// This member is required.
	Password *string

	// An array of Attribute objects that contain any LDAP attributes to apply to the computer
	// account.
	ComputerAttributes []types.Attribute

	// The fully-qualified distinguished name of the organizational unit to place the
	// computer account in.
	OrganizationalUnitDistinguishedName *string
	// contains filtered or unexported fields
}

Contains the inputs for the CreateComputer operation.

type CreateComputerOutput 

type CreateComputerOutput struct {

	// A Computer object that represents the computer account.
	Computer *types.Computer

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results for the CreateComputer operation.

type CreateConditionalForwarderInput 

type CreateConditionalForwarderInput struct {

	// The directory ID of the Amazon Web Services directory for which you are
	// creating the conditional forwarder.
	//
	// This member is required.
	DirectoryId *string

	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	//
	// This member is required.
	DnsIpAddrs []string

	// The fully qualified domain name (FQDN) of the remote domain with which you will
	// set up a trust relationship.
	//
	// This member is required.
	RemoteDomainName *string
	// contains filtered or unexported fields
}

Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

type CreateConditionalForwarderOutput 

type CreateConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a CreateConditinalForwarder request.

type CreateDirectoryInput 

type CreateDirectoryInput struct {

	// The fully qualified name for the directory, such as corp.example.com .
	//
	// This member is required.
	Name *string

	// The password for the directory administrator. The directory creation process
	// creates a directory administrator account with the user name Administrator and
	// this password.
	//
	// If you need to change the password for the administrator account, you can use
	// the ResetUserPasswordAPI call.
	//
	// The regex pattern for this string is made up of the following conditions:
	//
	//   - Length (?=^.{8,64}$) – Must be between 8 and 64 characters
	//
	// AND any 3 of the following password complexity rules required by Active
	// Directory:
	//
	//   - Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
	//
	//   - Numbers and special characters and lower case
	//   (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
	//
	//   - Special characters and upper case and lower case
	//   (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
	//
	//   - Numbers and upper case and special characters
	//   (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])
	//
	// For additional information about how Active Directory passwords are enforced,
	// see [Password must meet complexity requirements]on the Microsoft website.
	//
	// [Password must meet complexity requirements]: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements
	//
	// This member is required.
	Password *string

	// The size of the directory.
	//
	// This member is required.
	Size types.DirectorySize

	// A description for the directory.
	Description *string

	// The NetBIOS name of the directory, such as CORP .
	ShortName *string

	// The tags to be assigned to the Simple AD directory.
	Tags []types.Tag

	// A DirectoryVpcSettings object that contains additional information for the operation.
	VpcSettings *types.DirectoryVpcSettings
	// contains filtered or unexported fields
}

Contains the inputs for the CreateDirectory operation.

type CreateDirectoryOutput 

type CreateDirectoryOutput struct {

	// The identifier of the directory that was created.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the CreateDirectory operation.

type CreateLogSubscriptionInput 

type CreateLogSubscriptionInput struct {

	// Identifier of the directory to which you want to subscribe and receive
	// real-time logs to your specified CloudWatch log group.
	//
	// This member is required.
	DirectoryId *string

	// The name of the CloudWatch log group where the real-time domain controller logs
	// are forwarded.
	//
	// This member is required.
	LogGroupName *string
	// contains filtered or unexported fields
}

type CreateLogSubscriptionOutput 

type CreateLogSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMicrosoftADInput 

type CreateMicrosoftADInput struct {

	// The fully qualified domain name for the Managed Microsoft AD directory, such as
	// corp.example.com . This name will resolve inside your VPC only. It does not need
	// to be publicly resolvable.
	//
	// This member is required.
	Name *string

	// The password for the default administrative user named Admin .
	//
	// If you need to change the password for the administrator account, you can use
	// the ResetUserPasswordAPI call.
	//
	// This member is required.
	Password *string

	// Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
	//
	// This member is required.
	VpcSettings *types.DirectoryVpcSettings

	// A description for the directory. This label will appear on the Amazon Web
	// Services console Directory Details page after the directory is created.
	Description *string

	// Managed Microsoft AD is available in two editions: Standard and Enterprise .
	// Enterprise is the default.
	Edition types.DirectoryEdition

	// The NetBIOS name for your domain, such as CORP . If you don't specify a NetBIOS
	// name, it will default to the first part of your directory DNS. For example, CORP
	// for the directory DNS corp.example.com .
	ShortName *string

	// The tags to be assigned to the Managed Microsoft AD directory.
	Tags []types.Tag
	// contains filtered or unexported fields
}

Creates an Managed Microsoft AD directory.

type CreateMicrosoftADOutput 

type CreateMicrosoftADOutput struct {

	// The identifier of the directory that was created.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result of a CreateMicrosoftAD request.

type CreateSnapshotInput 

type CreateSnapshotInput struct {

	// The identifier of the directory of which to take a snapshot.
	//
	// This member is required.
	DirectoryId *string

	// The descriptive name to apply to the snapshot.
	Name *string
	// contains filtered or unexported fields
}

Contains the inputs for the CreateSnapshot operation.

type CreateSnapshotOutput 

type CreateSnapshotOutput struct {

	// The identifier of the snapshot that was created.
	SnapshotId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the CreateSnapshot operation.

type CreateTrustInput 

type CreateTrustInput struct {

	// The Directory ID of the Managed Microsoft AD directory for which to establish
	// the trust relationship.
	//
	// This member is required.
	DirectoryId *string

	// The Fully Qualified Domain Name (FQDN) of the external domain for which to
	// create the trust relationship.
	//
	// This member is required.
	RemoteDomainName *string

	// The direction of the trust relationship.
	//
	// This member is required.
	TrustDirection types.TrustDirection

	// The trust password. The trust password must be the same password that was used
	// when creating the trust relationship on the external domain.
	//
	// This member is required.
	TrustPassword *string

	// The IP addresses of the remote DNS server associated with RemoteDomainName.
	ConditionalForwarderIpAddrs []string

	// Optional parameter to enable selective authentication for the trust.
	SelectiveAuth types.SelectiveAuth

	// The trust relationship type. Forest is the default.
	TrustType types.TrustType
	// contains filtered or unexported fields
}

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

type CreateTrustOutput 

type CreateTrustOutput struct {

	// A unique identifier for the trust relationship that was created.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a CreateTrust request.

type DeleteConditionalForwarderInput 

type DeleteConditionalForwarderInput struct {

	// The directory ID for which you are deleting the conditional forwarder.
	//
	// This member is required.
	DirectoryId *string

	// The fully qualified domain name (FQDN) of the remote domain with which you are
	// deleting the conditional forwarder.
	//
	// This member is required.
	RemoteDomainName *string
	// contains filtered or unexported fields
}

Deletes a conditional forwarder.

type DeleteConditionalForwarderOutput 

type DeleteConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeleteConditionalForwarder request.

type DeleteDirectoryInput 

type DeleteDirectoryInput struct {

	// The identifier of the directory to delete.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteDirectory operation.

type DeleteDirectoryOutput 

type DeleteDirectoryOutput struct {

	// The directory identifier.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DeleteDirectory operation.

type DeleteLogSubscriptionInput 

type DeleteLogSubscriptionInput struct {

	// Identifier of the directory whose log subscription you want to delete.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type DeleteLogSubscriptionOutput 

type DeleteLogSubscriptionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSnapshotInput 

type DeleteSnapshotInput struct {

	// The identifier of the directory snapshot to be deleted.
	//
	// This member is required.
	SnapshotId *string
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteSnapshot operation.

type DeleteSnapshotOutput 

type DeleteSnapshotOutput struct {

	// The identifier of the directory snapshot that was deleted.
	SnapshotId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DeleteSnapshot operation.

type DeleteTrustInput 

type DeleteTrustInput struct {

	// The Trust ID of the trust relationship to be deleted.
	//
	// This member is required.
	TrustId *string

	// Delete a conditional forwarder as part of a DeleteTrustRequest.
	DeleteAssociatedConditionalForwarder bool
	// contains filtered or unexported fields
}

Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.

type DeleteTrustOutput 

type DeleteTrustOutput struct {

	// The Trust ID of the trust relationship that was deleted.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeleteTrust request.

type DeregisterCertificateInput 

type DeregisterCertificateInput struct {

	// The identifier of the certificate.
	//
	// This member is required.
	CertificateId *string

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type DeregisterCertificateOutput 

type DeregisterCertificateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeregisterEventTopicInput 

type DeregisterEventTopicInput struct {

	// The Directory ID to remove as a publisher. This directory will no longer send
	// messages to the specified Amazon SNS topic.
	//
	// This member is required.
	DirectoryId *string

	// The name of the Amazon SNS topic from which to remove the directory as a
	// publisher.
	//
	// This member is required.
	TopicName *string
	// contains filtered or unexported fields
}

Removes the specified directory as a publisher to the specified Amazon SNS topic.

type DeregisterEventTopicOutput 

type DeregisterEventTopicOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DeregisterEventTopic request.

type DescribeCertificateInput 

type DescribeCertificateInput struct {

	// The identifier of the certificate.
	//
	// This member is required.
	CertificateId *string

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type DescribeCertificateOutput 

type DescribeCertificateOutput struct {

	// Information about the certificate, including registered date time, certificate
	// state, the reason for the state, expiration date time, and certificate common
	// name.
	Certificate *types.Certificate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeClientAuthenticationSettingsAPIClient added in v1.15.0 

type DescribeClientAuthenticationSettingsAPIClient interface {
	DescribeClientAuthenticationSettings(context.Context, *DescribeClientAuthenticationSettingsInput, ...func(*Options)) (*DescribeClientAuthenticationSettingsOutput, error)
}

DescribeClientAuthenticationSettingsAPIClient is a client that implements the DescribeClientAuthenticationSettings operation.

type DescribeClientAuthenticationSettingsInput added in v1.4.0 

type DescribeClientAuthenticationSettingsInput struct {

	// The identifier of the directory for which to retrieve information.
	//
	// This member is required.
	DirectoryId *string

	// The maximum number of items to return. If this value is zero, the maximum
	// number of items is specified by the limitations of the operation.
	Limit *int32

	// The DescribeClientAuthenticationSettingsResult.NextToken value from a previous
	// call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
	NextToken *string

	// The type of client authentication for which to retrieve information. If no type
	// is specified, a list of all client authentication types that are supported for
	// the specified directory is retrieved.
	Type types.ClientAuthenticationType
	// contains filtered or unexported fields
}

type DescribeClientAuthenticationSettingsOutput added in v1.4.0 

type DescribeClientAuthenticationSettingsOutput struct {

	// Information about the type of client authentication for the specified
	// directory. The following information is retrieved: The date and time when the
	// status of the client authentication type was last updated, whether the client
	// authentication type is enabled or disabled, and the type of client
	// authentication.
	ClientAuthenticationSettingsInfo []types.ClientAuthenticationSettingInfo

	// The next token used to retrieve the client authentication settings if the
	// number of setting types exceeds page limit and there is another page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeClientAuthenticationSettingsPaginator added in v1.15.0 

type DescribeClientAuthenticationSettingsPaginator struct {
	// contains filtered or unexported fields
}

DescribeClientAuthenticationSettingsPaginator is a paginator for DescribeClientAuthenticationSettings

func NewDescribeClientAuthenticationSettingsPaginator added in v1.15.0 

func NewDescribeClientAuthenticationSettingsPaginator(client DescribeClientAuthenticationSettingsAPIClient, params *DescribeClientAuthenticationSettingsInput, optFns ...func(*DescribeClientAuthenticationSettingsPaginatorOptions)) *DescribeClientAuthenticationSettingsPaginator

NewDescribeClientAuthenticationSettingsPaginator returns a new DescribeClientAuthenticationSettingsPaginator

func (*DescribeClientAuthenticationSettingsPaginator) HasMorePages added in v1.15.0 

func (p *DescribeClientAuthenticationSettingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeClientAuthenticationSettingsPaginator) NextPage added in v1.15.0 

func (p *DescribeClientAuthenticationSettingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeClientAuthenticationSettingsOutput, error)

NextPage retrieves the next DescribeClientAuthenticationSettings page.

type DescribeClientAuthenticationSettingsPaginatorOptions added in v1.15.0 

type DescribeClientAuthenticationSettingsPaginatorOptions struct {
	// The maximum number of items to return. If this value is zero, the maximum
	// number of items is specified by the limitations of the operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeClientAuthenticationSettingsPaginatorOptions is the paginator options for DescribeClientAuthenticationSettings

type DescribeConditionalForwardersInput 

type DescribeConditionalForwardersInput struct {

	// The directory ID for which to get the list of associated conditional forwarders.
	//
	// This member is required.
	DirectoryId *string

	// The fully qualified domain names (FQDN) of the remote domains for which to get
	// the list of associated conditional forwarders. If this member is null, all
	// conditional forwarders are returned.
	RemoteDomainNames []string
	// contains filtered or unexported fields
}

Describes a conditional forwarder.

type DescribeConditionalForwardersOutput 

type DescribeConditionalForwardersOutput struct {

	// The list of conditional forwarders that have been created.
	ConditionalForwarders []types.ConditionalForwarder

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeConditionalForwarder request.

type DescribeDirectoriesAPIClient added in v1.15.0 

type DescribeDirectoriesAPIClient interface {
	DescribeDirectories(context.Context, *DescribeDirectoriesInput, ...func(*Options)) (*DescribeDirectoriesOutput, error)
}

DescribeDirectoriesAPIClient is a client that implements the DescribeDirectories operation.

type DescribeDirectoriesInput 

type DescribeDirectoriesInput struct {

	// A list of identifiers of the directories for which to obtain the information.
	// If this member is null, all directories that belong to the current account are
	// returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	DirectoryIds []string

	// The maximum number of items to return. If this value is zero, the maximum
	// number of items is specified by the limitations of the operation.
	Limit *int32

	// The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass
	// null if this is the first call.
	NextToken *string
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeDirectories operation.

type DescribeDirectoriesOutput 

type DescribeDirectoriesOutput struct {

	// The list of DirectoryDescription objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	DirectoryDescriptions []types.DirectoryDescription

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDirectoriesto retrieve the next set of items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DescribeDirectories operation.

type DescribeDirectoriesPaginator added in v1.15.0 

type DescribeDirectoriesPaginator struct {
	// contains filtered or unexported fields
}

DescribeDirectoriesPaginator is a paginator for DescribeDirectories

func NewDescribeDirectoriesPaginator added in v1.15.0 

func NewDescribeDirectoriesPaginator(client DescribeDirectoriesAPIClient, params *DescribeDirectoriesInput, optFns ...func(*DescribeDirectoriesPaginatorOptions)) *DescribeDirectoriesPaginator

NewDescribeDirectoriesPaginator returns a new DescribeDirectoriesPaginator

func (*DescribeDirectoriesPaginator) HasMorePages added in v1.15.0 

func (p *DescribeDirectoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDirectoriesPaginator) NextPage added in v1.15.0 

func (p *DescribeDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDirectoriesOutput, error)

NextPage retrieves the next DescribeDirectories page.

type DescribeDirectoriesPaginatorOptions added in v1.15.0 

type DescribeDirectoriesPaginatorOptions struct {
	// The maximum number of items to return. If this value is zero, the maximum
	// number of items is specified by the limitations of the operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeDirectoriesPaginatorOptions is the paginator options for DescribeDirectories

type DescribeDirectoryDataAccessInput added in v1.28.0 

type DescribeDirectoryDataAccessInput struct {

	// The directory identifier.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type DescribeDirectoryDataAccessOutput added in v1.28.0 

type DescribeDirectoryDataAccessOutput struct {

	// The current status of data access through the Directory Service Data API.
	DataAccessStatus types.DataAccessStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDomainControllersAPIClient added in v0.30.0 

type DescribeDomainControllersAPIClient interface {
	DescribeDomainControllers(context.Context, *DescribeDomainControllersInput, ...func(*Options)) (*DescribeDomainControllersOutput, error)
}

DescribeDomainControllersAPIClient is a client that implements the DescribeDomainControllers operation.

type DescribeDomainControllersInput 

type DescribeDomainControllersInput struct {

	// Identifier of the directory for which to retrieve the domain controller
	// information.
	//
	// This member is required.
	DirectoryId *string

	// A list of identifiers for the domain controllers whose information will be
	// provided.
	DomainControllerIds []string

	// The maximum number of items to return.
	Limit *int32

	// The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass
	// null if this is the first call.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeDomainControllersOutput 

type DescribeDomainControllersOutput struct {

	// List of the DomainController objects that were retrieved.
	DomainControllers []types.DomainController

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeDomainControllersretrieve the next set of items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDomainControllersPaginator added in v0.30.0 

type DescribeDomainControllersPaginator struct {
	// contains filtered or unexported fields
}

DescribeDomainControllersPaginator is a paginator for DescribeDomainControllers

func NewDescribeDomainControllersPaginator added in v0.30.0 

func NewDescribeDomainControllersPaginator(client DescribeDomainControllersAPIClient, params *DescribeDomainControllersInput, optFns ...func(*DescribeDomainControllersPaginatorOptions)) *DescribeDomainControllersPaginator

NewDescribeDomainControllersPaginator returns a new DescribeDomainControllersPaginator

func (*DescribeDomainControllersPaginator) HasMorePages added in v0.30.0 

func (p *DescribeDomainControllersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDomainControllersPaginator) NextPage added in v0.30.0 

func (p *DescribeDomainControllersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDomainControllersOutput, error)

NextPage retrieves the next DescribeDomainControllers page.

type DescribeDomainControllersPaginatorOptions added in v0.30.0 

type DescribeDomainControllersPaginatorOptions struct {
	// The maximum number of items to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeDomainControllersPaginatorOptions is the paginator options for DescribeDomainControllers

type DescribeEventTopicsInput 

type DescribeEventTopicsInput struct {

	// The Directory ID for which to get the list of associated Amazon SNS topics. If
	// this member is null, associations for all Directory IDs are returned.
	DirectoryId *string

	// A list of Amazon SNS topic names for which to obtain the information. If this
	// member is null, all associations for the specified Directory ID are returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	TopicNames []string
	// contains filtered or unexported fields
}

Describes event topics.

type DescribeEventTopicsOutput 

type DescribeEventTopicsOutput struct {

	// A list of Amazon SNS topic names that receive status messages from the
	// specified Directory ID.
	EventTopics []types.EventTopic

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeEventTopic request.

type DescribeLDAPSSettingsAPIClient added in v1.15.0 

type DescribeLDAPSSettingsAPIClient interface {
	DescribeLDAPSSettings(context.Context, *DescribeLDAPSSettingsInput, ...func(*Options)) (*DescribeLDAPSSettingsOutput, error)
}

DescribeLDAPSSettingsAPIClient is a client that implements the DescribeLDAPSSettings operation.

type DescribeLDAPSSettingsInput 

type DescribeLDAPSSettingsInput struct {

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// Specifies the number of items that should be displayed on one page.
	Limit *int32

	// The type of next token used for pagination.
	NextToken *string

	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	Type types.LDAPSType
	// contains filtered or unexported fields
}

type DescribeLDAPSSettingsOutput 

type DescribeLDAPSSettingsOutput struct {

	// Information about LDAP security for the specified directory, including status
	// of enablement, state last updated date time, and the reason for the state.
	LDAPSSettingsInfo []types.LDAPSSettingInfo

	// The next token used to retrieve the LDAPS settings if the number of setting
	// types exceeds page limit and there is another page.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLDAPSSettingsPaginator added in v1.15.0 

type DescribeLDAPSSettingsPaginator struct {
	// contains filtered or unexported fields
}

DescribeLDAPSSettingsPaginator is a paginator for DescribeLDAPSSettings

func NewDescribeLDAPSSettingsPaginator added in v1.15.0 

func NewDescribeLDAPSSettingsPaginator(client DescribeLDAPSSettingsAPIClient, params *DescribeLDAPSSettingsInput, optFns ...func(*DescribeLDAPSSettingsPaginatorOptions)) *DescribeLDAPSSettingsPaginator

NewDescribeLDAPSSettingsPaginator returns a new DescribeLDAPSSettingsPaginator

func (*DescribeLDAPSSettingsPaginator) HasMorePages added in v1.15.0 

func (p *DescribeLDAPSSettingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeLDAPSSettingsPaginator) NextPage added in v1.15.0 

func (p *DescribeLDAPSSettingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeLDAPSSettingsOutput, error)

NextPage retrieves the next DescribeLDAPSSettings page.

type DescribeLDAPSSettingsPaginatorOptions added in v1.15.0 

type DescribeLDAPSSettingsPaginatorOptions struct {
	// Specifies the number of items that should be displayed on one page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeLDAPSSettingsPaginatorOptions is the paginator options for DescribeLDAPSSettings

type DescribeRegionsAPIClient added in v1.15.0 

type DescribeRegionsAPIClient interface {
	DescribeRegions(context.Context, *DescribeRegionsInput, ...func(*Options)) (*DescribeRegionsOutput, error)
}

DescribeRegionsAPIClient is a client that implements the DescribeRegions operation.

type DescribeRegionsInput added in v0.30.0 

type DescribeRegionsInput struct {

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null
	// if this is the first call.
	NextToken *string

	// The name of the Region. For example, us-east-1 .
	RegionName *string
	// contains filtered or unexported fields
}

type DescribeRegionsOutput added in v0.30.0 

type DescribeRegionsOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeRegionsto retrieve the next set of items.
	NextToken *string

	// List of Region information related to the directory for each replicated Region.
	RegionsDescription []types.RegionDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRegionsPaginator added in v1.15.0 

type DescribeRegionsPaginator struct {
	// contains filtered or unexported fields
}

DescribeRegionsPaginator is a paginator for DescribeRegions

func NewDescribeRegionsPaginator added in v1.15.0 

func NewDescribeRegionsPaginator(client DescribeRegionsAPIClient, params *DescribeRegionsInput, optFns ...func(*DescribeRegionsPaginatorOptions)) *DescribeRegionsPaginator

NewDescribeRegionsPaginator returns a new DescribeRegionsPaginator

func (*DescribeRegionsPaginator) HasMorePages added in v1.15.0 

func (p *DescribeRegionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeRegionsPaginator) NextPage added in v1.15.0 

func (p *DescribeRegionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegionsOutput, error)

NextPage retrieves the next DescribeRegions page.

type DescribeRegionsPaginatorOptions added in v1.15.0 

type DescribeRegionsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeRegionsPaginatorOptions is the paginator options for DescribeRegions

type DescribeSettingsInput added in v1.14.0 

type DescribeSettingsInput struct {

	// The identifier of the directory for which to retrieve information.
	//
	// This member is required.
	DirectoryId *string

	// The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null
	// if this is the first call.
	NextToken *string

	// The status of the directory settings for which to retrieve information.
	Status types.DirectoryConfigurationStatus
	// contains filtered or unexported fields
}

type DescribeSettingsOutput added in v1.14.0 

type DescribeSettingsOutput struct {

	// The identifier of the directory.
	DirectoryId *string

	// If not null, token that indicates that more results are available. Pass this
	// value for the NextToken parameter in a subsequent call to DescribeSettings to
	// retrieve the next set of items.
	NextToken *string

	// The list of SettingEntry objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	SettingEntries []types.SettingEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSharedDirectoriesAPIClient added in v1.15.0 

type DescribeSharedDirectoriesAPIClient interface {
	DescribeSharedDirectories(context.Context, *DescribeSharedDirectoriesInput, ...func(*Options)) (*DescribeSharedDirectoriesOutput, error)
}

DescribeSharedDirectoriesAPIClient is a client that implements the DescribeSharedDirectories operation.

type DescribeSharedDirectoriesInput 

type DescribeSharedDirectoriesInput struct {

	// Returns the identifier of the directory in the directory owner account.
	//
	// This member is required.
	OwnerDirectoryId *string

	// The number of shared directories to return in the response object.
	Limit *int32

	// The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories.
	// Pass null if this is the first call.
	NextToken *string

	// A list of identifiers of all shared directories in your account.
	SharedDirectoryIds []string
	// contains filtered or unexported fields
}

type DescribeSharedDirectoriesOutput 

type DescribeSharedDirectoriesOutput struct {

	// If not null, token that indicates that more results are available. Pass this
	// value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next
	// set of items.
	NextToken *string

	// A list of all shared directories in your account.
	SharedDirectories []types.SharedDirectory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSharedDirectoriesPaginator added in v1.15.0 

type DescribeSharedDirectoriesPaginator struct {
	// contains filtered or unexported fields
}

DescribeSharedDirectoriesPaginator is a paginator for DescribeSharedDirectories

func NewDescribeSharedDirectoriesPaginator added in v1.15.0 

func NewDescribeSharedDirectoriesPaginator(client DescribeSharedDirectoriesAPIClient, params *DescribeSharedDirectoriesInput, optFns ...func(*DescribeSharedDirectoriesPaginatorOptions)) *DescribeSharedDirectoriesPaginator

NewDescribeSharedDirectoriesPaginator returns a new DescribeSharedDirectoriesPaginator

func (*DescribeSharedDirectoriesPaginator) HasMorePages added in v1.15.0 

func (p *DescribeSharedDirectoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSharedDirectoriesPaginator) NextPage added in v1.15.0 

func (p *DescribeSharedDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSharedDirectoriesOutput, error)

NextPage retrieves the next DescribeSharedDirectories page.

type DescribeSharedDirectoriesPaginatorOptions added in v1.15.0 

type DescribeSharedDirectoriesPaginatorOptions struct {
	// The number of shared directories to return in the response object.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeSharedDirectoriesPaginatorOptions is the paginator options for DescribeSharedDirectories

type DescribeSnapshotsAPIClient added in v1.15.0 

type DescribeSnapshotsAPIClient interface {
	DescribeSnapshots(context.Context, *DescribeSnapshotsInput, ...func(*Options)) (*DescribeSnapshotsOutput, error)
}

DescribeSnapshotsAPIClient is a client that implements the DescribeSnapshots operation.

type DescribeSnapshotsInput 

type DescribeSnapshotsInput struct {

	// The identifier of the directory for which to retrieve snapshot information.
	DirectoryId *string

	// The maximum number of objects to return.
	Limit *int32

	// The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null
	// if this is the first call.
	NextToken *string

	// A list of identifiers of the snapshots to obtain the information for. If this
	// member is null or empty, all snapshots are returned using the Limit and
	// NextToken members.
	SnapshotIds []string
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeSnapshots operation.

type DescribeSnapshotsOutput 

type DescribeSnapshotsOutput struct {

	// If not null, more results are available. Pass this value in the NextToken
	// member of a subsequent call to DescribeSnapshots.
	NextToken *string

	// The list of Snapshot objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	Snapshots []types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DescribeSnapshots operation.

type DescribeSnapshotsPaginator added in v1.15.0 

type DescribeSnapshotsPaginator struct {
	// contains filtered or unexported fields
}

DescribeSnapshotsPaginator is a paginator for DescribeSnapshots

func NewDescribeSnapshotsPaginator added in v1.15.0 

func NewDescribeSnapshotsPaginator(client DescribeSnapshotsAPIClient, params *DescribeSnapshotsInput, optFns ...func(*DescribeSnapshotsPaginatorOptions)) *DescribeSnapshotsPaginator

NewDescribeSnapshotsPaginator returns a new DescribeSnapshotsPaginator

func (*DescribeSnapshotsPaginator) HasMorePages added in v1.15.0 

func (p *DescribeSnapshotsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSnapshotsPaginator) NextPage added in v1.15.0 

func (p *DescribeSnapshotsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error)

NextPage retrieves the next DescribeSnapshots page.

type DescribeSnapshotsPaginatorOptions added in v1.15.0 

type DescribeSnapshotsPaginatorOptions struct {
	// The maximum number of objects to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeSnapshotsPaginatorOptions is the paginator options for DescribeSnapshots

type DescribeTrustsAPIClient added in v1.15.0 

type DescribeTrustsAPIClient interface {
	DescribeTrusts(context.Context, *DescribeTrustsInput, ...func(*Options)) (*DescribeTrustsOutput, error)
}

DescribeTrustsAPIClient is a client that implements the DescribeTrusts operation.

type DescribeTrustsInput 

type DescribeTrustsInput struct {

	// The Directory ID of the Amazon Web Services directory that is a part of the
	// requested trust relationship.
	DirectoryId *string

	// The maximum number of objects to return.
	Limit *int32

	// The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if
	// this is the first call.
	NextToken *string

	// A list of identifiers of the trust relationships for which to obtain the
	// information. If this member is null, all trust relationships that belong to the
	// current account are returned.
	//
	// An empty list results in an InvalidParameterException being thrown.
	TrustIds []string
	// contains filtered or unexported fields
}

Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.

type DescribeTrustsOutput 

type DescribeTrustsOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to DescribeTruststo retrieve the next set of items.
	NextToken *string

	// The list of Trust objects that were retrieved.
	//
	// It is possible that this list contains less than the number of items specified
	// in the Limit member of the request. This occurs if there are less than the
	// requested number of items left to retrieve, or if the limitations of the
	// operation have been exceeded.
	Trusts []types.Trust

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a DescribeTrust request.

type DescribeTrustsPaginator added in v1.15.0 

type DescribeTrustsPaginator struct {
	// contains filtered or unexported fields
}

DescribeTrustsPaginator is a paginator for DescribeTrusts

func NewDescribeTrustsPaginator added in v1.15.0 

func NewDescribeTrustsPaginator(client DescribeTrustsAPIClient, params *DescribeTrustsInput, optFns ...func(*DescribeTrustsPaginatorOptions)) *DescribeTrustsPaginator

NewDescribeTrustsPaginator returns a new DescribeTrustsPaginator

func (*DescribeTrustsPaginator) HasMorePages added in v1.15.0 

func (p *DescribeTrustsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeTrustsPaginator) NextPage added in v1.15.0 

func (p *DescribeTrustsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeTrustsOutput, error)

NextPage retrieves the next DescribeTrusts page.

type DescribeTrustsPaginatorOptions added in v1.15.0 

type DescribeTrustsPaginatorOptions struct {
	// The maximum number of objects to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeTrustsPaginatorOptions is the paginator options for DescribeTrusts

type DescribeUpdateDirectoryAPIClient added in v1.15.0 

type DescribeUpdateDirectoryAPIClient interface {
	DescribeUpdateDirectory(context.Context, *DescribeUpdateDirectoryInput, ...func(*Options)) (*DescribeUpdateDirectoryOutput, error)
}

DescribeUpdateDirectoryAPIClient is a client that implements the DescribeUpdateDirectory operation.

type DescribeUpdateDirectoryInput added in v1.15.0 

type DescribeUpdateDirectoryInput struct {

	//  The unique identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	//  The type of updates you want to describe for the directory.
	//
	// This member is required.
	UpdateType types.UpdateType

	//  The DescribeUpdateDirectoryResult . NextToken value from a previous call to DescribeUpdateDirectory.
	// Pass null if this is the first call.
	NextToken *string

	//  The name of the Region.
	RegionName *string
	// contains filtered or unexported fields
}

type DescribeUpdateDirectoryOutput added in v1.15.0 

type DescribeUpdateDirectoryOutput struct {

	//  If not null, more results are available. Pass this value for the NextToken
	// parameter.
	NextToken *string

	//  The list of update activities on a directory for the requested update type.
	UpdateActivities []types.UpdateInfoEntry

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeUpdateDirectoryPaginator added in v1.15.0 

type DescribeUpdateDirectoryPaginator struct {
	// contains filtered or unexported fields
}

DescribeUpdateDirectoryPaginator is a paginator for DescribeUpdateDirectory

func NewDescribeUpdateDirectoryPaginator added in v1.15.0 

func NewDescribeUpdateDirectoryPaginator(client DescribeUpdateDirectoryAPIClient, params *DescribeUpdateDirectoryInput, optFns ...func(*DescribeUpdateDirectoryPaginatorOptions)) *DescribeUpdateDirectoryPaginator

NewDescribeUpdateDirectoryPaginator returns a new DescribeUpdateDirectoryPaginator

func (*DescribeUpdateDirectoryPaginator) HasMorePages added in v1.15.0 

func (p *DescribeUpdateDirectoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeUpdateDirectoryPaginator) NextPage added in v1.15.0 

func (p *DescribeUpdateDirectoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeUpdateDirectoryOutput, error)

NextPage retrieves the next DescribeUpdateDirectory page.

type DescribeUpdateDirectoryPaginatorOptions added in v1.15.0 

type DescribeUpdateDirectoryPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeUpdateDirectoryPaginatorOptions is the paginator options for DescribeUpdateDirectory

type DisableClientAuthenticationInput added in v0.31.0 

type DisableClientAuthenticationInput struct {

	// The identifier of the directory
	//
	// This member is required.
	DirectoryId *string

	// The type of client authentication to disable. Currently the only parameter
	// "SmartCard" is supported.
	//
	// This member is required.
	Type types.ClientAuthenticationType
	// contains filtered or unexported fields
}

type DisableClientAuthenticationOutput added in v0.31.0 

type DisableClientAuthenticationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableDirectoryDataAccessInput added in v1.28.0 

type DisableDirectoryDataAccessInput struct {

	// The directory identifier.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type DisableDirectoryDataAccessOutput added in v1.28.0 

type DisableDirectoryDataAccessOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableLDAPSInput 

type DisableLDAPSInput struct {

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	//
	// This member is required.
	Type types.LDAPSType
	// contains filtered or unexported fields
}

type DisableLDAPSOutput 

type DisableLDAPSOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableRadiusInput 

type DisableRadiusInput struct {

	// The identifier of the directory for which to disable MFA.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

Contains the inputs for the DisableRadius operation.

type DisableRadiusOutput 

type DisableRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DisableRadius operation.

type DisableSsoInput 

type DisableSsoInput struct {

	// The identifier of the directory for which to disable single-sign on.
	//
	// This member is required.
	DirectoryId *string

	// The password of an alternate account to use to disable single-sign on. This is
	// only used for AD Connector directories. For more information, see the UserName
	// parameter.
	Password *string

	// The username of an alternate account to use to disable single-sign on. This is
	// only used for AD Connector directories. This account must have privileges to
	// remove a service principal name.
	//
	// If the AD Connector service account does not have privileges to remove a
	// service principal name, you can specify an alternate account with the UserName
	// and Password parameters. These credentials are only used to disable single
	// sign-on and are not stored by the service. The AD Connector service account is
	// not changed.
	UserName *string
	// contains filtered or unexported fields
}

Contains the inputs for the DisableSso operation.

type DisableSsoOutput 

type DisableSsoOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the DisableSso operation.

type EnableClientAuthenticationInput added in v0.31.0 

type EnableClientAuthenticationInput struct {

	// The identifier of the specified directory.
	//
	// This member is required.
	DirectoryId *string

	// The type of client authentication to enable. Currently only the value SmartCard
	// is supported. Smart card authentication in AD Connector requires that you enable
	// Kerberos Constrained Delegation for the Service User to the LDAP service in your
	// self-managed AD.
	//
	// This member is required.
	Type types.ClientAuthenticationType
	// contains filtered or unexported fields
}

type EnableClientAuthenticationOutput added in v0.31.0 

type EnableClientAuthenticationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableDirectoryDataAccessInput added in v1.28.0 

type EnableDirectoryDataAccessInput struct {

	// The directory identifier.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type EnableDirectoryDataAccessOutput added in v1.28.0 

type EnableDirectoryDataAccessOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableLDAPSInput 

type EnableLDAPSInput struct {

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// The type of LDAP security to enable. Currently only the value Client is
	// supported.
	//
	// This member is required.
	Type types.LDAPSType
	// contains filtered or unexported fields
}

type EnableLDAPSOutput 

type EnableLDAPSOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EnableRadiusInput 

type EnableRadiusInput struct {

	// The identifier of the directory for which to enable MFA.
	//
	// This member is required.
	DirectoryId *string

	// A RadiusSettings object that contains information about the RADIUS server.
	//
	// This member is required.
	RadiusSettings *types.RadiusSettings
	// contains filtered or unexported fields
}

Contains the inputs for the EnableRadius operation.

type EnableRadiusOutput 

type EnableRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the EnableRadius operation.

type EnableSsoInput 

type EnableSsoInput struct {

	// The identifier of the directory for which to enable single-sign on.
	//
	// This member is required.
	DirectoryId *string

	// The password of an alternate account to use to enable single-sign on. This is
	// only used for AD Connector directories. For more information, see the UserName
	// parameter.
	Password *string

	// The username of an alternate account to use to enable single-sign on. This is
	// only used for AD Connector directories. This account must have privileges to add
	// a service principal name.
	//
	// If the AD Connector service account does not have privileges to add a service
	// principal name, you can specify an alternate account with the UserName and
	// Password parameters. These credentials are only used to enable single sign-on
	// and are not stored by the service. The AD Connector service account is not
	// changed.
	UserName *string
	// contains filtered or unexported fields
}

Contains the inputs for the EnableSso operation.

type EnableSsoOutput 

type EnableSsoOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the EnableSso operation.

type EndpointParameters added in v1.18.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.18.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.18.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.18.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.18.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDirectoryLimitsInput 

type GetDirectoryLimitsInput struct {
	// contains filtered or unexported fields
}

Contains the inputs for the GetDirectoryLimits operation.

type GetDirectoryLimitsOutput 

type GetDirectoryLimitsOutput struct {

	// A DirectoryLimits object that contains the directory limits for the current Region.
	DirectoryLimits *types.DirectoryLimits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the GetDirectoryLimits operation.

type GetSnapshotLimitsInput 

type GetSnapshotLimitsInput struct {

	// Contains the identifier of the directory to obtain the limits for.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

Contains the inputs for the GetSnapshotLimits operation.

type GetSnapshotLimitsOutput 

type GetSnapshotLimitsOutput struct {

	// A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
	SnapshotLimits *types.SnapshotLimits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the GetSnapshotLimits operation.

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListCertificatesAPIClient added in v1.15.0 

type ListCertificatesAPIClient interface {
	ListCertificates(context.Context, *ListCertificatesInput, ...func(*Options)) (*ListCertificatesOutput, error)
}

ListCertificatesAPIClient is a client that implements the ListCertificates operation.

type ListCertificatesInput 

type ListCertificatesInput struct {

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// The number of items that should show up on one page
	Limit *int32

	// A token for requesting another page of certificates if the NextToken response
	// element indicates that more certificates are available. Use the value of the
	// returned NextToken element in your request until the token comes back as null .
	// Pass null if this is the first call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCertificatesOutput 

type ListCertificatesOutput struct {

	// A list of certificates with basic details including certificate ID, certificate
	// common name, certificate state.
	CertificatesInfo []types.CertificateInfo

	// Indicates whether another page of certificates is available when the number of
	// available certificates exceeds the page limit.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCertificatesPaginator added in v1.15.0 

type ListCertificatesPaginator struct {
	// contains filtered or unexported fields
}

ListCertificatesPaginator is a paginator for ListCertificates

func NewListCertificatesPaginator added in v1.15.0 

func NewListCertificatesPaginator(client ListCertificatesAPIClient, params *ListCertificatesInput, optFns ...func(*ListCertificatesPaginatorOptions)) *ListCertificatesPaginator

NewListCertificatesPaginator returns a new ListCertificatesPaginator

func (*ListCertificatesPaginator) HasMorePages added in v1.15.0 

func (p *ListCertificatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCertificatesPaginator) NextPage added in v1.15.0 

func (p *ListCertificatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCertificatesOutput, error)

NextPage retrieves the next ListCertificates page.

type ListCertificatesPaginatorOptions added in v1.15.0 

type ListCertificatesPaginatorOptions struct {
	// The number of items that should show up on one page
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCertificatesPaginatorOptions is the paginator options for ListCertificates

type ListIpRoutesAPIClient added in v1.15.0 

type ListIpRoutesAPIClient interface {
	ListIpRoutes(context.Context, *ListIpRoutesInput, ...func(*Options)) (*ListIpRoutesOutput, error)
}

ListIpRoutesAPIClient is a client that implements the ListIpRoutes operation.

type ListIpRoutesInput 

type ListIpRoutesInput struct {

	// Identifier (ID) of the directory for which you want to retrieve the IP
	// addresses.
	//
	// This member is required.
	DirectoryId *string

	// Maximum number of items to return. If this value is zero, the maximum number of
	// items is specified by the limitations of the operation.
	Limit *int32

	// The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is
	// the first call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListIpRoutesOutput 

type ListIpRoutesOutput struct {

	// A list of IpRoutes.
	IpRoutesInfo []types.IpRouteInfo

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListIpRoutesto retrieve the next set of items.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIpRoutesPaginator added in v1.15.0 

type ListIpRoutesPaginator struct {
	// contains filtered or unexported fields
}

ListIpRoutesPaginator is a paginator for ListIpRoutes

func NewListIpRoutesPaginator added in v1.15.0 

func NewListIpRoutesPaginator(client ListIpRoutesAPIClient, params *ListIpRoutesInput, optFns ...func(*ListIpRoutesPaginatorOptions)) *ListIpRoutesPaginator

NewListIpRoutesPaginator returns a new ListIpRoutesPaginator

func (*ListIpRoutesPaginator) HasMorePages added in v1.15.0 

func (p *ListIpRoutesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIpRoutesPaginator) NextPage added in v1.15.0 

func (p *ListIpRoutesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIpRoutesOutput, error)

NextPage retrieves the next ListIpRoutes page.

type ListIpRoutesPaginatorOptions added in v1.15.0 

type ListIpRoutesPaginatorOptions struct {
	// Maximum number of items to return. If this value is zero, the maximum number of
	// items is specified by the limitations of the operation.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIpRoutesPaginatorOptions is the paginator options for ListIpRoutes

type ListLogSubscriptionsAPIClient added in v1.15.0 

type ListLogSubscriptionsAPIClient interface {
	ListLogSubscriptions(context.Context, *ListLogSubscriptionsInput, ...func(*Options)) (*ListLogSubscriptionsOutput, error)
}

ListLogSubscriptionsAPIClient is a client that implements the ListLogSubscriptions operation.

type ListLogSubscriptionsInput 

type ListLogSubscriptionsInput struct {

	// If a DirectoryID is provided, lists only the log subscription associated with
	// that directory. If no DirectoryId is provided, lists all log subscriptions
	// associated with your Amazon Web Services account. If there are no log
	// subscriptions for the Amazon Web Services account or the directory, an empty
	// list will be returned.
	DirectoryId *string

	// The maximum number of items returned.
	Limit *int32

	// The token for the next set of items to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListLogSubscriptionsOutput 

type ListLogSubscriptionsOutput struct {

	// A list of active LogSubscription objects for calling the Amazon Web Services account.
	LogSubscriptions []types.LogSubscription

	// The token for the next set of items to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLogSubscriptionsPaginator added in v1.15.0 

type ListLogSubscriptionsPaginator struct {
	// contains filtered or unexported fields
}

ListLogSubscriptionsPaginator is a paginator for ListLogSubscriptions

func NewListLogSubscriptionsPaginator added in v1.15.0 

func NewListLogSubscriptionsPaginator(client ListLogSubscriptionsAPIClient, params *ListLogSubscriptionsInput, optFns ...func(*ListLogSubscriptionsPaginatorOptions)) *ListLogSubscriptionsPaginator

NewListLogSubscriptionsPaginator returns a new ListLogSubscriptionsPaginator

func (*ListLogSubscriptionsPaginator) HasMorePages added in v1.15.0 

func (p *ListLogSubscriptionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLogSubscriptionsPaginator) NextPage added in v1.15.0 

func (p *ListLogSubscriptionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLogSubscriptionsOutput, error)

NextPage retrieves the next ListLogSubscriptions page.

type ListLogSubscriptionsPaginatorOptions added in v1.15.0 

type ListLogSubscriptionsPaginatorOptions struct {
	// The maximum number of items returned.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLogSubscriptionsPaginatorOptions is the paginator options for ListLogSubscriptions

type ListSchemaExtensionsAPIClient added in v1.15.0 

type ListSchemaExtensionsAPIClient interface {
	ListSchemaExtensions(context.Context, *ListSchemaExtensionsInput, ...func(*Options)) (*ListSchemaExtensionsOutput, error)
}

ListSchemaExtensionsAPIClient is a client that implements the ListSchemaExtensions operation.

type ListSchemaExtensionsInput 

type ListSchemaExtensionsInput struct {

	// The identifier of the directory from which to retrieve the schema extension
	// information.
	//
	// This member is required.
	DirectoryId *string

	// The maximum number of items to return.
	Limit *int32

	// The ListSchemaExtensions.NextToken value from a previous call to
	// ListSchemaExtensions . Pass null if this is the first call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSchemaExtensionsOutput 

type ListSchemaExtensionsOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to ListSchemaExtensions to retrieve the next set
	// of items.
	NextToken *string

	// Information about the schema extensions applied to the directory.
	SchemaExtensionsInfo []types.SchemaExtensionInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSchemaExtensionsPaginator added in v1.15.0 

type ListSchemaExtensionsPaginator struct {
	// contains filtered or unexported fields
}

ListSchemaExtensionsPaginator is a paginator for ListSchemaExtensions

func NewListSchemaExtensionsPaginator added in v1.15.0 

func NewListSchemaExtensionsPaginator(client ListSchemaExtensionsAPIClient, params *ListSchemaExtensionsInput, optFns ...func(*ListSchemaExtensionsPaginatorOptions)) *ListSchemaExtensionsPaginator

NewListSchemaExtensionsPaginator returns a new ListSchemaExtensionsPaginator

func (*ListSchemaExtensionsPaginator) HasMorePages added in v1.15.0 

func (p *ListSchemaExtensionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSchemaExtensionsPaginator) NextPage added in v1.15.0 

func (p *ListSchemaExtensionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchemaExtensionsOutput, error)

NextPage retrieves the next ListSchemaExtensions page.

type ListSchemaExtensionsPaginatorOptions added in v1.15.0 

type ListSchemaExtensionsPaginatorOptions struct {
	// The maximum number of items to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSchemaExtensionsPaginatorOptions is the paginator options for ListSchemaExtensions

type ListTagsForResourceAPIClient added in v1.15.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// Identifier (ID) of the directory for which you want to retrieve tags.
	//
	// This member is required.
	ResourceId *string

	// Reserved for future use.
	Limit *int32

	// Reserved for future use.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Reserved for future use.
	NextToken *string

	// List of tags returned by the ListTagsForResource operation.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v1.15.0 

type ListTagsForResourcePaginator struct {
	// contains filtered or unexported fields
}

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v1.15.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v1.15.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v1.15.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v1.15.0 

type ListTagsForResourcePaginatorOptions struct {
	// Reserved for future use.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.21.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RegisterCertificateInput 

type RegisterCertificateInput struct {

	// The certificate PEM string that needs to be registered.
	//
	// This member is required.
	CertificateData *string

	// The identifier of the directory.
	//
	// This member is required.
	DirectoryId *string

	// A ClientCertAuthSettings object that contains client certificate authentication
	// settings.
	ClientCertAuthSettings *types.ClientCertAuthSettings

	// The function that the registered certificate performs. Valid values include
	// ClientLDAPS or ClientCertAuth . The default value is ClientLDAPS .
	Type types.CertificateType
	// contains filtered or unexported fields
}

type RegisterCertificateOutput 

type RegisterCertificateOutput struct {

	// The identifier of the certificate.
	CertificateId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RegisterEventTopicInput 

type RegisterEventTopicInput struct {

	// The Directory ID that will publish status messages to the Amazon SNS topic.
	//
	// This member is required.
	DirectoryId *string

	// The Amazon SNS topic name to which the directory will publish status messages.
	// This Amazon SNS topic must be in the same region as the specified Directory ID.
	//
	// This member is required.
	TopicName *string
	// contains filtered or unexported fields
}

Registers a new event topic.

type RegisterEventTopicOutput 

type RegisterEventTopicOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of a RegisterEventTopic request.

type RejectSharedDirectoryInput 

type RejectSharedDirectoryInput struct {

	// Identifier of the shared directory in the directory consumer account. This
	// identifier is different for each directory owner account.
	//
	// This member is required.
	SharedDirectoryId *string
	// contains filtered or unexported fields
}

type RejectSharedDirectoryOutput 

type RejectSharedDirectoryOutput struct {

	// Identifier of the shared directory in the directory consumer account.
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveIpRoutesInput 

type RemoveIpRoutesInput struct {

	// IP address blocks that you want to remove.
	//
	// This member is required.
	CidrIps []string

	// Identifier (ID) of the directory from which you want to remove the IP addresses.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type RemoveIpRoutesOutput 

type RemoveIpRoutesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveRegionInput added in v0.30.0 

type RemoveRegionInput struct {

	// The identifier of the directory for which you want to remove Region replication.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type RemoveRegionOutput added in v0.30.0 

type RemoveRegionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveTagsFromResourceInput 

type RemoveTagsFromResourceInput struct {

	// Identifier (ID) of the directory from which to remove the tag.
	//
	// This member is required.
	ResourceId *string

	// The tag key (name) of the tag to be removed.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type RemoveTagsFromResourceOutput 

type RemoveTagsFromResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResetUserPasswordInput 

type ResetUserPasswordInput struct {

	// Identifier of the Managed Microsoft AD or Simple AD directory in which the user
	// resides.
	//
	// This member is required.
	DirectoryId *string

	// The new password that will be reset.
	//
	// This member is required.
	NewPassword *string

	// The user name of the user whose password will be reset.
	//
	// This member is required.
	UserName *string
	// contains filtered or unexported fields
}

type ResetUserPasswordOutput 

type ResetUserPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type RestoreFromSnapshotInput 

type RestoreFromSnapshotInput struct {

	// The identifier of the snapshot to restore from.
	//
	// This member is required.
	SnapshotId *string
	// contains filtered or unexported fields
}

An object representing the inputs for the RestoreFromSnapshot operation.

type RestoreFromSnapshotOutput 

type RestoreFromSnapshotOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the RestoreFromSnapshot operation.

type ShareDirectoryInput 

type ShareDirectoryInput struct {

	// Identifier of the Managed Microsoft AD directory that you want to share with
	// other Amazon Web Services accounts.
	//
	// This member is required.
	DirectoryId *string

	// The method used when sharing a directory to determine whether the directory
	// should be shared within your Amazon Web Services organization ( ORGANIZATIONS )
	// or with any Amazon Web Services account by sending a directory sharing request (
	// HANDSHAKE ).
	//
	// This member is required.
	ShareMethod types.ShareMethod

	// Identifier for the directory consumer account with whom the directory is to be
	// shared.
	//
	// This member is required.
	ShareTarget *types.ShareTarget

	// A directory share request that is sent by the directory owner to the directory
	// consumer. The request includes a typed message to help the directory consumer
	// administrator determine whether to approve or reject the share invitation.
	ShareNotes *string
	// contains filtered or unexported fields
}

type ShareDirectoryOutput 

type ShareDirectoryOutput struct {

	// Identifier of the directory that is stored in the directory consumer account
	// that is shared from the specified directory ( DirectoryId ).
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSchemaExtensionInput 

type StartSchemaExtensionInput struct {

	// If true, creates a snapshot of the directory before applying the schema
	// extension.
	//
	// This member is required.
	CreateSnapshotBeforeSchemaExtension bool

	// A description of the schema extension.
	//
	// This member is required.
	Description *string

	// The identifier of the directory for which the schema extension will be applied
	// to.
	//
	// This member is required.
	DirectoryId *string

	// The LDIF file represented as a string. To construct the LdifContent string,
	// precede each line as it would be formatted in an ldif file with \n. See the
	// example request below for more details. The file size can be no larger than 1MB.
	//
	// This member is required.
	LdifContent *string
	// contains filtered or unexported fields
}

type StartSchemaExtensionOutput 

type StartSchemaExtensionOutput struct {

	// The identifier of the schema extension that will be applied.
	SchemaExtensionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UnshareDirectoryInput 

type UnshareDirectoryInput struct {

	// The identifier of the Managed Microsoft AD directory that you want to stop
	// sharing.
	//
	// This member is required.
	DirectoryId *string

	// Identifier for the directory consumer account with whom the directory has to be
	// unshared.
	//
	// This member is required.
	UnshareTarget *types.UnshareTarget
	// contains filtered or unexported fields
}

type UnshareDirectoryOutput 

type UnshareDirectoryOutput struct {

	// Identifier of the directory stored in the directory consumer account that is to
	// be unshared from the specified directory ( DirectoryId ).
	SharedDirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateConditionalForwarderInput 

type UpdateConditionalForwarderInput struct {

	// The directory ID of the Amazon Web Services directory for which to update the
	// conditional forwarder.
	//
	// This member is required.
	DirectoryId *string

	// The updated IP addresses of the remote DNS server associated with the
	// conditional forwarder.
	//
	// This member is required.
	DnsIpAddrs []string

	// The fully qualified domain name (FQDN) of the remote domain with which you will
	// set up a trust relationship.
	//
	// This member is required.
	RemoteDomainName *string
	// contains filtered or unexported fields
}

Updates a conditional forwarder.

type UpdateConditionalForwarderOutput 

type UpdateConditionalForwarderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

The result of an UpdateConditionalForwarder request.

type UpdateDirectorySetupInput added in v1.15.0 

type UpdateDirectorySetupInput struct {

	//  The identifier of the directory on which you want to perform the update.
	//
	// This member is required.
	DirectoryId *string

	//  The type of update that needs to be performed on the directory. For example,
	// OS.
	//
	// This member is required.
	UpdateType types.UpdateType

	//  The boolean that specifies if a snapshot for the directory needs to be taken
	// before updating the directory.
	CreateSnapshotBeforeUpdate *bool

	//  The settings for the OS update that needs to be performed on the directory.
	OSUpdateSettings *types.OSUpdateSettings
	// contains filtered or unexported fields
}

type UpdateDirectorySetupOutput added in v1.15.0 

type UpdateDirectorySetupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateNumberOfDomainControllersInput 

type UpdateNumberOfDomainControllersInput struct {

	// The number of domain controllers desired in the directory.
	//
	// This member is required.
	DesiredNumber *int32

	// Identifier of the directory to which the domain controllers will be added or
	// removed.
	//
	// This member is required.
	DirectoryId *string
	// contains filtered or unexported fields
}

type UpdateNumberOfDomainControllersOutput 

type UpdateNumberOfDomainControllersOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRadiusInput 

type UpdateRadiusInput struct {

	// The identifier of the directory for which to update the RADIUS server
	// information.
	//
	// This member is required.
	DirectoryId *string

	// A RadiusSettings object that contains information about the RADIUS server.
	//
	// This member is required.
	RadiusSettings *types.RadiusSettings
	// contains filtered or unexported fields
}

Contains the inputs for the UpdateRadius operation.

type UpdateRadiusOutput 

type UpdateRadiusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Contains the results of the UpdateRadius operation.

type UpdateSettingsInput added in v1.14.0 

type UpdateSettingsInput struct {

	// The identifier of the directory for which to update settings.
	//
	// This member is required.
	DirectoryId *string

	// The list of Setting objects.
	//
	// This member is required.
	Settings []types.Setting
	// contains filtered or unexported fields
}

type UpdateSettingsOutput added in v1.14.0 

type UpdateSettingsOutput struct {

	// The identifier of the directory.
	DirectoryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateTrustInput 

type UpdateTrustInput struct {

	// Identifier of the trust relationship.
	//
	// This member is required.
	TrustId *string

	// Updates selective authentication for the trust.
	SelectiveAuth types.SelectiveAuth
	// contains filtered or unexported fields
}

type UpdateTrustOutput 

type UpdateTrustOutput struct {

	// The Amazon Web Services request identifier.
	RequestId *string

	// Identifier of the trust relationship.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type VerifyTrustInput 

type VerifyTrustInput struct {

	// The unique Trust ID of the trust relationship to verify.
	//
	// This member is required.
	TrustId *string
	// contains filtered or unexported fields
}

Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.

type VerifyTrustOutput 

type VerifyTrustOutput struct {

	// The unique Trust ID of the trust relationship that was verified.
	TrustId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Result of a VerifyTrust request.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.