worklink

package module
v1.4.1 Latest Latest
Warning

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

 Go to latest Published: Sep 17, 2021 License: Apache-2.0 Imports: 28 Imported by: 6

Documentation

Overview

Package worklink provides the API client, operations, and parameter types for Amazon WorkLink.

Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS and Android phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-09-25"
View Source 
const ServiceID = "WorkLink"

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 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateDomainInput 

type AssociateDomainInput struct {

	// The ARN of an issued ACM certificate that is valid for the domain being
	// associated.
	//
	// This member is required.
	AcmCertificateArn *string

	// The fully qualified domain name (FQDN).
	//
	// This member is required.
	DomainName *string

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The name to display.
	DisplayName *string
	// contains filtered or unexported fields
}

type AssociateDomainOutput 

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

type AssociateWebsiteAuthorizationProviderInput 

type AssociateWebsiteAuthorizationProviderInput struct {

	// The authorization provider type.
	//
	// This member is required.
	AuthorizationProviderType types.AuthorizationProviderType

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The domain name of the authorization provider. This applies only to SAML-based
	// authorization providers.
	DomainName *string
	// contains filtered or unexported fields
}

type AssociateWebsiteAuthorizationProviderOutput 

type AssociateWebsiteAuthorizationProviderOutput struct {

	// A unique identifier for the authorization provider.
	AuthorizationProviderId *string

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

type AssociateWebsiteCertificateAuthorityInput 

type AssociateWebsiteCertificateAuthorityInput struct {

	// The root certificate of the CA.
	//
	// This member is required.
	Certificate *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The certificate name to display.
	DisplayName *string
	// contains filtered or unexported fields
}

type AssociateWebsiteCertificateAuthorityOutput 

type AssociateWebsiteCertificateAuthorityOutput struct {

	// A unique identifier for the CA.
	WebsiteCaId *string

	// 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 Amazon WorkLink.

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) AssociateDomain 

func (c *Client) AssociateDomain(ctx context.Context, params *AssociateDomainInput, optFns ...func(*Options)) (*AssociateDomainOutput, error)

Specifies a domain to be associated to Amazon WorkLink.

func (*Client) AssociateWebsiteAuthorizationProvider 

func (c *Client) AssociateWebsiteAuthorizationProvider(ctx context.Context, params *AssociateWebsiteAuthorizationProviderInput, optFns ...func(*Options)) (*AssociateWebsiteAuthorizationProviderOutput, error)

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

func (*Client) AssociateWebsiteCertificateAuthority 

func (c *Client) AssociateWebsiteCertificateAuthority(ctx context.Context, params *AssociateWebsiteCertificateAuthorityInput, optFns ...func(*Options)) (*AssociateWebsiteCertificateAuthorityOutput, error)

Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

func (*Client) CreateFleet 

func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error)

Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

func (*Client) DeleteFleet 

func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error)

Deletes a fleet. Prevents users from accessing previously associated websites.

func (*Client) DescribeAuditStreamConfiguration 

func (c *Client) DescribeAuditStreamConfiguration(ctx context.Context, params *DescribeAuditStreamConfigurationInput, optFns ...func(*Options)) (*DescribeAuditStreamConfigurationOutput, error)

Describes the configuration for delivering audit streams to the customer account.

func (*Client) DescribeCompanyNetworkConfiguration 

func (c *Client) DescribeCompanyNetworkConfiguration(ctx context.Context, params *DescribeCompanyNetworkConfigurationInput, optFns ...func(*Options)) (*DescribeCompanyNetworkConfigurationOutput, error)

Describes the networking configuration to access the internal websites associated with the specified fleet.

func (*Client) DescribeDevice 

func (c *Client) DescribeDevice(ctx context.Context, params *DescribeDeviceInput, optFns ...func(*Options)) (*DescribeDeviceOutput, error)

Provides information about a user's device.

func (*Client) DescribeDevicePolicyConfiguration 

func (c *Client) DescribeDevicePolicyConfiguration(ctx context.Context, params *DescribeDevicePolicyConfigurationInput, optFns ...func(*Options)) (*DescribeDevicePolicyConfigurationOutput, error)

Describes the device policy configuration for the specified fleet.

func (*Client) DescribeDomain 

func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error)

Provides information about the domain.

func (*Client) DescribeFleetMetadata 

func (c *Client) DescribeFleetMetadata(ctx context.Context, params *DescribeFleetMetadataInput, optFns ...func(*Options)) (*DescribeFleetMetadataOutput, error)

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

func (*Client) DescribeIdentityProviderConfiguration 

func (c *Client) DescribeIdentityProviderConfiguration(ctx context.Context, params *DescribeIdentityProviderConfigurationInput, optFns ...func(*Options)) (*DescribeIdentityProviderConfigurationOutput, error)

Describes the identity provider configuration of the specified fleet.

func (*Client) DescribeWebsiteCertificateAuthority 

func (c *Client) DescribeWebsiteCertificateAuthority(ctx context.Context, params *DescribeWebsiteCertificateAuthorityInput, optFns ...func(*Options)) (*DescribeWebsiteCertificateAuthorityOutput, error)

Provides information about the certificate authority.

func (*Client) DisassociateDomain 

func (c *Client) DisassociateDomain(ctx context.Context, params *DisassociateDomainInput, optFns ...func(*Options)) (*DisassociateDomainOutput, error)

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

func (*Client) DisassociateWebsiteAuthorizationProvider 

func (c *Client) DisassociateWebsiteAuthorizationProvider(ctx context.Context, params *DisassociateWebsiteAuthorizationProviderInput, optFns ...func(*Options)) (*DisassociateWebsiteAuthorizationProviderOutput, error)

Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

func (*Client) DisassociateWebsiteCertificateAuthority 

func (c *Client) DisassociateWebsiteCertificateAuthority(ctx context.Context, params *DisassociateWebsiteCertificateAuthorityInput, optFns ...func(*Options)) (*DisassociateWebsiteCertificateAuthorityOutput, error)

Removes a certificate authority (CA).

func (*Client) ListDevices 

func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

Retrieves a list of devices registered with the specified fleet.

func (*Client) ListDomains 

func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error)

Retrieves a list of domains associated to a specified fleet.

func (*Client) ListFleets 

func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error)

Retrieves a list of fleets for the current account and Region.

func (*Client) ListTagsForResource 

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

Retrieves a list of tags for the specified resource.

func (*Client) ListWebsiteAuthorizationProviders 

func (c *Client) ListWebsiteAuthorizationProviders(ctx context.Context, params *ListWebsiteAuthorizationProvidersInput, optFns ...func(*Options)) (*ListWebsiteAuthorizationProvidersOutput, error)

Retrieves a list of website authorization providers associated with a specified fleet.

func (*Client) ListWebsiteCertificateAuthorities 

func (c *Client) ListWebsiteCertificateAuthorities(ctx context.Context, params *ListWebsiteCertificateAuthoritiesInput, optFns ...func(*Options)) (*ListWebsiteCertificateAuthoritiesOutput, error)

Retrieves a list of certificate authorities added for the current account and Region.

func (*Client) RestoreDomainAccess 

func (c *Client) RestoreDomainAccess(ctx context.Context, params *RestoreDomainAccessInput, optFns ...func(*Options)) (*RestoreDomainAccessOutput, error)

Moves a domain to ACTIVE status if it was in the INACTIVE status.

func (*Client) RevokeDomainAccess 

func (c *Client) RevokeDomainAccess(ctx context.Context, params *RevokeDomainAccessInput, optFns ...func(*Options)) (*RevokeDomainAccessOutput, error)

Moves a domain to INACTIVE status if it was in the ACTIVE status.

func (*Client) SignOutUser 

func (c *Client) SignOutUser(ctx context.Context, params *SignOutUserInput, optFns ...func(*Options)) (*SignOutUserOutput, error)

Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from the specified resource.

func (*Client) UpdateAuditStreamConfiguration 

func (c *Client) UpdateAuditStreamConfiguration(ctx context.Context, params *UpdateAuditStreamConfigurationInput, optFns ...func(*Options)) (*UpdateAuditStreamConfigurationOutput, error)

Updates the audit stream configuration for the fleet.

func (*Client) UpdateCompanyNetworkConfiguration 

func (c *Client) UpdateCompanyNetworkConfiguration(ctx context.Context, params *UpdateCompanyNetworkConfigurationInput, optFns ...func(*Options)) (*UpdateCompanyNetworkConfigurationOutput, error)

Updates the company network configuration for the fleet.

func (*Client) UpdateDevicePolicyConfiguration 

func (c *Client) UpdateDevicePolicyConfiguration(ctx context.Context, params *UpdateDevicePolicyConfigurationInput, optFns ...func(*Options)) (*UpdateDevicePolicyConfigurationOutput, error)

Updates the device policy configuration for the fleet.

func (*Client) UpdateDomainMetadata 

func (c *Client) UpdateDomainMetadata(ctx context.Context, params *UpdateDomainMetadataInput, optFns ...func(*Options)) (*UpdateDomainMetadataOutput, error)

Updates domain metadata, such as DisplayName.

func (*Client) UpdateFleetMetadata 

func (c *Client) UpdateFleetMetadata(ctx context.Context, params *UpdateFleetMetadataInput, optFns ...func(*Options)) (*UpdateFleetMetadataOutput, error)

Updates fleet metadata, such as DisplayName.

func (*Client) UpdateIdentityProviderConfiguration 

func (c *Client) UpdateIdentityProviderConfiguration(ctx context.Context, params *UpdateIdentityProviderConfigurationInput, optFns ...func(*Options)) (*UpdateIdentityProviderConfigurationOutput, error)

Updates the identity provider configuration for the fleet.

type CreateFleetInput 

type CreateFleetInput struct {

	// A unique name for the fleet.
	//
	// This member is required.
	FleetName *string

	// The fleet name to display.
	DisplayName *string

	// The option to optimize for better performance by routing traffic through the
	// closest AWS Region to users, which may be outside of your home Region.
	OptimizeForEndUserLocation *bool

	// The tags to add to the resource. A tag is a key-value pair.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFleetOutput 

type CreateFleetOutput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	FleetArn *string

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

type DeleteFleetInput 

type DeleteFleetInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DeleteFleetOutput 

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

type DescribeAuditStreamConfigurationInput 

type DescribeAuditStreamConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeAuditStreamConfigurationOutput 

type DescribeAuditStreamConfigurationOutput struct {

	// The ARN of the Amazon Kinesis data stream that will receive the audit events.
	AuditStreamArn *string

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

type DescribeCompanyNetworkConfigurationInput 

type DescribeCompanyNetworkConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeCompanyNetworkConfigurationOutput 

type DescribeCompanyNetworkConfigurationOutput struct {

	// The security groups associated with access to the provided subnets.
	SecurityGroupIds []string

	// The subnets used for X-ENI connections from Amazon WorkLink rendering
	// containers.
	SubnetIds []string

	// The VPC with connectivity to associated websites.
	VpcId *string

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

type DescribeDeviceInput 

type DescribeDeviceInput struct {

	// A unique identifier for a registered user's device.
	//
	// This member is required.
	DeviceId *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeDeviceOutput 

type DescribeDeviceOutput struct {

	// The date that the device first signed in to Amazon WorkLink.
	FirstAccessedTime *time.Time

	// The date that the device last accessed Amazon WorkLink.
	LastAccessedTime *time.Time

	// The manufacturer of the device.
	Manufacturer *string

	// The model of the device.
	Model *string

	// The operating system of the device.
	OperatingSystem *string

	// The operating system version of the device.
	OperatingSystemVersion *string

	// The operating system patch level of the device.
	PatchLevel *string

	// The current state of the device.
	Status types.DeviceStatus

	// The user name associated with the device.
	Username *string

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

type DescribeDevicePolicyConfigurationInput 

type DescribeDevicePolicyConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeDevicePolicyConfigurationOutput 

type DescribeDevicePolicyConfigurationOutput struct {

	// The certificate chain, including intermediate certificates and the root
	// certificate authority certificate used to issue device certificates.
	DeviceCaCertificate *string

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

type DescribeDomainInput 

type DescribeDomainInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeDomainOutput 

type DescribeDomainOutput struct {

	// The ARN of an issued ACM certificate that is valid for the domain being
	// associated.
	AcmCertificateArn *string

	// The time that the domain was added.
	CreatedTime *time.Time

	// The name to display.
	DisplayName *string

	// The name of the domain.
	DomainName *string

	// The current state for the domain.
	DomainStatus types.DomainStatus

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

type DescribeFleetMetadataInput 

type DescribeFleetMetadataInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeFleetMetadataOutput 

type DescribeFleetMetadataOutput struct {

	// The identifier used by users to sign in to the Amazon WorkLink app.
	CompanyCode *string

	// The time that the fleet was created.
	CreatedTime *time.Time

	// The name to display.
	DisplayName *string

	// The name of the fleet.
	FleetName *string

	// The current state of the fleet.
	FleetStatus types.FleetStatus

	// The time that the fleet was last updated.
	LastUpdatedTime *time.Time

	// The option to optimize for better performance by routing traffic through the
	// closest AWS Region to users, which may be outside of your home Region.
	OptimizeForEndUserLocation *bool

	// The tags attached to the resource. A tag is a key-value pair.
	Tags map[string]string

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

type DescribeIdentityProviderConfigurationInput 

type DescribeIdentityProviderConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DescribeIdentityProviderConfigurationOutput 

type DescribeIdentityProviderConfigurationOutput struct {

	// The SAML metadata document provided by the user’s identity provider.
	IdentityProviderSamlMetadata *string

	// The type of identity provider.
	IdentityProviderType types.IdentityProviderType

	// The SAML metadata document uploaded to the user’s identity provider.
	ServiceProviderSamlMetadata *string

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

type DescribeWebsiteCertificateAuthorityInput 

type DescribeWebsiteCertificateAuthorityInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// A unique identifier for the certificate authority.
	//
	// This member is required.
	WebsiteCaId *string
	// contains filtered or unexported fields
}

type DescribeWebsiteCertificateAuthorityOutput 

type DescribeWebsiteCertificateAuthorityOutput struct {

	// The root certificate of the certificate authority.
	Certificate *string

	// The time that the certificate authority was added.
	CreatedTime *time.Time

	// The certificate name to display.
	DisplayName *string

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

type DisassociateDomainInput 

type DisassociateDomainInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DisassociateDomainOutput 

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

type DisassociateWebsiteAuthorizationProviderInput 

type DisassociateWebsiteAuthorizationProviderInput struct {

	// A unique identifier for the authorization provider.
	//
	// This member is required.
	AuthorizationProviderId *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type DisassociateWebsiteAuthorizationProviderOutput 

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

type DisassociateWebsiteCertificateAuthorityInput 

type DisassociateWebsiteCertificateAuthorityInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// A unique identifier for the CA.
	//
	// This member is required.
	WebsiteCaId *string
	// contains filtered or unexported fields
}

type DisassociateWebsiteCertificateAuthorityOutput 

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

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 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 ListDevicesAPIClient added in v0.30.0 

type ListDevicesAPIClient interface {
	ListDevices(context.Context, *ListDevicesInput, ...func(*Options)) (*ListDevicesOutput, error)
}

ListDevicesAPIClient is a client that implements the ListDevices operation.

type ListDevicesInput 

type ListDevicesInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The maximum number of results to be included in the next page.
	MaxResults *int32

	// The pagination token used to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDevicesOutput 

type ListDevicesOutput struct {

	// Information about the devices.
	Devices []types.DeviceSummary

	// The pagination token used to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

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

type ListDevicesPaginator added in v0.30.0 

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

ListDevicesPaginator is a paginator for ListDevices

func NewListDevicesPaginator added in v0.30.0 

func NewListDevicesPaginator(client ListDevicesAPIClient, params *ListDevicesInput, optFns ...func(*ListDevicesPaginatorOptions)) *ListDevicesPaginator

NewListDevicesPaginator returns a new ListDevicesPaginator

func (*ListDevicesPaginator) HasMorePages added in v0.30.0 

func (p *ListDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevicesPaginator) NextPage added in v0.30.0 

func (p *ListDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicesOutput, error)

NextPage retrieves the next ListDevices page.

type ListDevicesPaginatorOptions added in v0.30.0 

type ListDevicesPaginatorOptions struct {
	// The maximum number of results to be included in the next 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
}

ListDevicesPaginatorOptions is the paginator options for ListDevices

type ListDomainsAPIClient added in v0.30.0 

type ListDomainsAPIClient interface {
	ListDomains(context.Context, *ListDomainsInput, ...func(*Options)) (*ListDomainsOutput, error)
}

ListDomainsAPIClient is a client that implements the ListDomains operation.

type ListDomainsInput 

type ListDomainsInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The maximum number of results to be included in the next page.
	MaxResults *int32

	// The pagination token used to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDomainsOutput 

type ListDomainsOutput struct {

	// Information about the domains.
	Domains []types.DomainSummary

	// The pagination token used to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

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

type ListDomainsPaginator added in v0.30.0 

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

ListDomainsPaginator is a paginator for ListDomains

func NewListDomainsPaginator added in v0.30.0 

func NewListDomainsPaginator(client ListDomainsAPIClient, params *ListDomainsInput, optFns ...func(*ListDomainsPaginatorOptions)) *ListDomainsPaginator

NewListDomainsPaginator returns a new ListDomainsPaginator

func (*ListDomainsPaginator) HasMorePages added in v0.30.0 

func (p *ListDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsPaginator) NextPage added in v0.30.0 

func (p *ListDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainsOutput, error)

NextPage retrieves the next ListDomains page.

type ListDomainsPaginatorOptions added in v0.30.0 

type ListDomainsPaginatorOptions struct {
	// The maximum number of results to be included in the next 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
}

ListDomainsPaginatorOptions is the paginator options for ListDomains

type ListFleetsAPIClient added in v0.30.0 

type ListFleetsAPIClient interface {
	ListFleets(context.Context, *ListFleetsInput, ...func(*Options)) (*ListFleetsOutput, error)
}

ListFleetsAPIClient is a client that implements the ListFleets operation.

type ListFleetsInput 

type ListFleetsInput struct {

	// The maximum number of results to be included in the next page.
	MaxResults *int32

	// The pagination token used to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFleetsOutput 

type ListFleetsOutput struct {

	// The summary list of the fleets.
	FleetSummaryList []types.FleetSummary

	// The pagination token used to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

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

type ListFleetsPaginator added in v0.30.0 

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

ListFleetsPaginator is a paginator for ListFleets

func NewListFleetsPaginator added in v0.30.0 

func NewListFleetsPaginator(client ListFleetsAPIClient, params *ListFleetsInput, optFns ...func(*ListFleetsPaginatorOptions)) *ListFleetsPaginator

NewListFleetsPaginator returns a new ListFleetsPaginator

func (*ListFleetsPaginator) HasMorePages added in v0.30.0 

func (p *ListFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFleetsPaginator) NextPage added in v0.30.0 

func (p *ListFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFleetsOutput, error)

NextPage retrieves the next ListFleets page.

type ListFleetsPaginatorOptions added in v0.30.0 

type ListFleetsPaginatorOptions struct {
	// The maximum number of results to be included in the next 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
}

ListFleetsPaginatorOptions is the paginator options for ListFleets

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags attached to the resource. A tag is a key-value pair.
	Tags map[string]string

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

type ListWebsiteAuthorizationProvidersAPIClient added in v0.30.0 

type ListWebsiteAuthorizationProvidersAPIClient interface {
	ListWebsiteAuthorizationProviders(context.Context, *ListWebsiteAuthorizationProvidersInput, ...func(*Options)) (*ListWebsiteAuthorizationProvidersOutput, error)
}

ListWebsiteAuthorizationProvidersAPIClient is a client that implements the ListWebsiteAuthorizationProviders operation.

type ListWebsiteAuthorizationProvidersInput 

type ListWebsiteAuthorizationProvidersInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The maximum number of results to be included in the next page.
	MaxResults *int32

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWebsiteAuthorizationProvidersOutput 

type ListWebsiteAuthorizationProvidersOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string

	// The website authorization providers.
	WebsiteAuthorizationProviders []types.WebsiteAuthorizationProviderSummary

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

type ListWebsiteAuthorizationProvidersPaginator added in v0.30.0 

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

ListWebsiteAuthorizationProvidersPaginator is a paginator for ListWebsiteAuthorizationProviders

func NewListWebsiteAuthorizationProvidersPaginator added in v0.30.0 

func NewListWebsiteAuthorizationProvidersPaginator(client ListWebsiteAuthorizationProvidersAPIClient, params *ListWebsiteAuthorizationProvidersInput, optFns ...func(*ListWebsiteAuthorizationProvidersPaginatorOptions)) *ListWebsiteAuthorizationProvidersPaginator

NewListWebsiteAuthorizationProvidersPaginator returns a new ListWebsiteAuthorizationProvidersPaginator

func (*ListWebsiteAuthorizationProvidersPaginator) HasMorePages added in v0.30.0 

func (p *ListWebsiteAuthorizationProvidersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWebsiteAuthorizationProvidersPaginator) NextPage added in v0.30.0 

func (p *ListWebsiteAuthorizationProvidersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWebsiteAuthorizationProvidersOutput, error)

NextPage retrieves the next ListWebsiteAuthorizationProviders page.

type ListWebsiteAuthorizationProvidersPaginatorOptions added in v0.30.0 

type ListWebsiteAuthorizationProvidersPaginatorOptions struct {
	// The maximum number of results to be included in the next 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
}

ListWebsiteAuthorizationProvidersPaginatorOptions is the paginator options for ListWebsiteAuthorizationProviders

type ListWebsiteCertificateAuthoritiesAPIClient added in v0.30.0 

type ListWebsiteCertificateAuthoritiesAPIClient interface {
	ListWebsiteCertificateAuthorities(context.Context, *ListWebsiteCertificateAuthoritiesInput, ...func(*Options)) (*ListWebsiteCertificateAuthoritiesOutput, error)
}

ListWebsiteCertificateAuthoritiesAPIClient is a client that implements the ListWebsiteCertificateAuthorities operation.

type ListWebsiteCertificateAuthoritiesInput 

type ListWebsiteCertificateAuthoritiesInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The maximum number of results to be included in the next page.
	MaxResults *int32

	// The pagination token used to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListWebsiteCertificateAuthoritiesOutput 

type ListWebsiteCertificateAuthoritiesOutput struct {

	// The pagination token used to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// Information about the certificates.
	WebsiteCertificateAuthorities []types.WebsiteCaSummary

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

type ListWebsiteCertificateAuthoritiesPaginator added in v0.30.0 

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

ListWebsiteCertificateAuthoritiesPaginator is a paginator for ListWebsiteCertificateAuthorities

func NewListWebsiteCertificateAuthoritiesPaginator added in v0.30.0 

func NewListWebsiteCertificateAuthoritiesPaginator(client ListWebsiteCertificateAuthoritiesAPIClient, params *ListWebsiteCertificateAuthoritiesInput, optFns ...func(*ListWebsiteCertificateAuthoritiesPaginatorOptions)) *ListWebsiteCertificateAuthoritiesPaginator

NewListWebsiteCertificateAuthoritiesPaginator returns a new ListWebsiteCertificateAuthoritiesPaginator

func (*ListWebsiteCertificateAuthoritiesPaginator) HasMorePages added in v0.30.0 

func (p *ListWebsiteCertificateAuthoritiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWebsiteCertificateAuthoritiesPaginator) NextPage added in v0.30.0 

func (p *ListWebsiteCertificateAuthoritiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWebsiteCertificateAuthoritiesOutput, error)

NextPage retrieves the next ListWebsiteCertificateAuthorities page.

type ListWebsiteCertificateAuthoritiesPaginatorOptions added in v0.30.0 

type ListWebsiteCertificateAuthoritiesPaginatorOptions struct {
	// The maximum number of results to be included in the next 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
}

ListWebsiteCertificateAuthoritiesPaginatorOptions is the paginator options for ListWebsiteCertificateAuthorities

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

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

func (Options) Copy 

func (o Options) Copy() Options

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

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 RestoreDomainAccessInput 

type RestoreDomainAccessInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type RestoreDomainAccessOutput 

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

type RevokeDomainAccessInput 

type RevokeDomainAccessInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string
	// contains filtered or unexported fields
}

type RevokeDomainAccessOutput 

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

type SignOutUserInput 

type SignOutUserInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The name of the user.
	//
	// This member is required.
	Username *string
	// contains filtered or unexported fields
}

type SignOutUserOutput 

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to the resource. A tag is a key-value pair.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateAuditStreamConfigurationInput 

type UpdateAuditStreamConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The ARN of the Amazon Kinesis data stream that receives the audit events.
	AuditStreamArn *string
	// contains filtered or unexported fields
}

type UpdateAuditStreamConfigurationOutput 

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

type UpdateCompanyNetworkConfigurationInput 

type UpdateCompanyNetworkConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The security groups associated with access to the provided subnets.
	//
	// This member is required.
	SecurityGroupIds []string

	// The subnets used for X-ENI connections from Amazon WorkLink rendering
	// containers.
	//
	// This member is required.
	SubnetIds []string

	// The VPC with connectivity to associated websites.
	//
	// This member is required.
	VpcId *string
	// contains filtered or unexported fields
}

type UpdateCompanyNetworkConfigurationOutput 

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

type UpdateDevicePolicyConfigurationInput 

type UpdateDevicePolicyConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The certificate chain, including intermediate certificates and the root
	// certificate authority certificate used to issue device certificates.
	DeviceCaCertificate *string
	// contains filtered or unexported fields
}

type UpdateDevicePolicyConfigurationOutput 

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

type UpdateDomainMetadataInput 

type UpdateDomainMetadataInput struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The name to display.
	DisplayName *string
	// contains filtered or unexported fields
}

type UpdateDomainMetadataOutput 

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

type UpdateFleetMetadataInput 

type UpdateFleetMetadataInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The fleet name to display. The existing DisplayName is unset if null is passed.
	DisplayName *string

	// The option to optimize for better performance by routing traffic through the
	// closest AWS Region to users, which may be outside of your home Region.
	OptimizeForEndUserLocation *bool
	// contains filtered or unexported fields
}

type UpdateFleetMetadataOutput 

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

type UpdateIdentityProviderConfigurationInput 

type UpdateIdentityProviderConfigurationInput struct {

	// The ARN of the fleet.
	//
	// This member is required.
	FleetArn *string

	// The type of identity provider.
	//
	// This member is required.
	IdentityProviderType types.IdentityProviderType

	// The SAML metadata document provided by the customer’s identity provider. The
	// existing IdentityProviderSamlMetadata is unset if null is passed.
	IdentityProviderSamlMetadata *string
	// contains filtered or unexported fields
}

type UpdateIdentityProviderConfigurationOutput 

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

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.