ram

package module
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2021 License: Apache-2.0 Imports: 27 Imported by: 23

Documentation

Overview

Package ram provides the API client, operations, and parameter types for AWS Resource Access Manager.

Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations. For more information, see the AWS Resource Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/).

Index

Constants

View Source 
const ServiceAPIVersion = "2018-01-04"
View Source 
const ServiceID = "RAM"

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 AcceptResourceShareInvitationInput 

type AcceptResourceShareInvitationInput struct {

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

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string
}

type AcceptResourceShareInvitationOutput 

type AcceptResourceShareInvitationOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the invitation.
	ResourceShareInvitation *types.ResourceShareInvitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateResourceShareInput 

type AssociateResourceShareInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// The principals to associate with the resource share. The possible values are IDs
	// of AWS accounts, and the ARNs of organizational units (OU) or organizations from
	// AWS Organizations.
	Principals []string

	// The Amazon Resource Names (ARN) of the resources.
	ResourceArns []string
}

type AssociateResourceShareOutput 

type AssociateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the associations.
	ResourceShareAssociations []types.ResourceShareAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AssociateResourceSharePermissionInput 

type AssociateResourceSharePermissionInput struct {

	// The ARN of the AWS RAM permission to associate with the resource share.
	//
	// This member is required.
	PermissionArn *string

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Indicates whether the permission should replace the permissions that are
	// currently associated with the resource share. Use true to replace the current
	// permissions. Use false to add the permission to the current permission.
	Replace *bool
}

type AssociateResourceSharePermissionOutput 

type AssociateResourceSharePermissionOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Indicates whether the request succeeded.
	ReturnValue *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

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

Client provides the API client to make operations call for AWS Resource Access Manager.

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

func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, optFns ...func(*Options)) (*AcceptResourceShareInvitationOutput, error)

Accepts an invitation to a resource share from another AWS account.

func (*Client) AssociateResourceShare 

func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error)

Associates the specified resource share with the specified principals and resources.

func (*Client) AssociateResourceSharePermission 

func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, optFns ...func(*Options)) (*AssociateResourceSharePermissionOutput, error)

Associates a permission with a resource share.

func (*Client) CreateResourceShare 

func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error)

Creates a resource share.

func (*Client) DeleteResourceShare 

func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error)

Deletes the specified resource share.

func (*Client) DisassociateResourceShare 

func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, optFns ...func(*Options)) (*DisassociateResourceShareOutput, error)

Disassociates the specified principals or resources from the specified resource share.

func (*Client) DisassociateResourceSharePermission 

func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, optFns ...func(*Options)) (*DisassociateResourceSharePermissionOutput, error)

Disassociates an AWS RAM permission from a resource share.

func (*Client) EnableSharingWithAwsOrganization 

func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error)

Enables resource sharing within your AWS Organization. The caller must be the master account for the AWS Organization.

func (*Client) GetPermission 

func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error)

Gets the contents of an AWS RAM permission in JSON format.

func (*Client) GetResourcePolicies 

func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)

Gets the policies for the specified resources that you own and have shared.

func (*Client) GetResourceShareAssociations 

func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)

Gets the resources or principals for the resource shares that you own.

func (*Client) GetResourceShareInvitations 

func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)

Gets the invitations for resource sharing that you've received.

func (*Client) GetResourceShares 

func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error)

Gets the resource shares that you own or the resource shares that are shared with you.

func (*Client) ListPendingInvitationResources 

func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)

Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

func (*Client) ListPermissions 

func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)

Lists the AWS RAM permissions.

func (*Client) ListPrincipals 

func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error)

Lists the principals that you have shared resources with or that have shared resources with you.

func (*Client) ListResourceSharePermissions 

func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)

Lists the AWS RAM permissions that are associated with a resource share.

func (*Client) ListResourceTypes 

func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error)

Lists the shareable resource types supported by AWS RAM.

func (*Client) ListResources 

func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)

Lists the resources that you added to a resource shares or the resources that are shared with you.

func (*Client) PromoteResourceShareCreatedFromPolicy 

func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error)

Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM. Use this API action to promote the resource share. When you promote the resource share, it becomes:

* Visible to all principals that it is shared with.

* Modifiable in AWS RAM.

func (*Client) RejectResourceShareInvitation 

func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, optFns ...func(*Options)) (*RejectResourceShareInvitationOutput, error)

Rejects an invitation to a resource share from another AWS account.

func (*Client) TagResource 

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

Adds the specified tags to the specified resource share that you own.

func (*Client) UntagResource 

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

Removes the specified tags from the specified resource share that you own.

func (*Client) UpdateResourceShare 

func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResourceShareInput, optFns ...func(*Options)) (*UpdateResourceShareOutput, error)

Updates the specified resource share that you own.

type CreateResourceShareInput 

type CreateResourceShareInput struct {

	// The name of the resource share.
	//
	// This member is required.
	Name *string

	// Indicates whether principals outside your AWS organization can be associated
	// with a resource share.
	AllowExternalPrincipals *bool

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// The ARNs of the permissions to associate with the resource share. If you do not
	// specify an ARN for the permission, AWS RAM automatically attaches the default
	// version of the permission for each resource type.
	PermissionArns []string

	// The principals to associate with the resource share. The possible values are IDs
	// of AWS accounts, the ARN of an OU or organization from AWS Organizations.
	Principals []string

	// The Amazon Resource Names (ARN) of the resources to associate with the resource
	// share.
	ResourceArns []string

	// One or more tags.
	Tags []types.Tag
}

type CreateResourceShareOutput 

type CreateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the resource share.
	ResourceShare *types.ResourceShare

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteResourceShareInput 

type DeleteResourceShareInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string
}

type DeleteResourceShareOutput 

type DeleteResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Indicates whether the request succeeded.
	ReturnValue *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateResourceShareInput 

type DisassociateResourceShareInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// The principals.
	Principals []string

	// The Amazon Resource Names (ARNs) of the resources.
	ResourceArns []string
}

type DisassociateResourceShareOutput 

type DisassociateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the associations.
	ResourceShareAssociations []types.ResourceShareAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateResourceSharePermissionInput 

type DisassociateResourceSharePermissionInput struct {

	// The ARN of the permission to disassociate from the resource share.
	//
	// This member is required.
	PermissionArn *string

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string
}

type DisassociateResourceSharePermissionOutput 

type DisassociateResourceSharePermissionOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Indicates whether the request succeeded.
	ReturnValue *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EnableSharingWithAwsOrganizationInput 

type EnableSharingWithAwsOrganizationInput struct {
}

type EnableSharingWithAwsOrganizationOutput 

type EnableSharingWithAwsOrganizationOutput struct {

	// Indicates whether the request succeeded.
	ReturnValue *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 GetPermissionInput 

type GetPermissionInput struct {

	// The ARN of the permission.
	//
	// This member is required.
	PermissionArn *string

	// The identifier for the version of the permission.
	PermissionVersion *int32
}

type GetPermissionOutput 

type GetPermissionOutput struct {

	// Information about the permission.
	Permission *types.ResourceSharePermissionDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourcePoliciesAPIClient added in v0.30.0 

type GetResourcePoliciesAPIClient interface {
	GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error)
}

GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies operation.

type GetResourcePoliciesInput 

type GetResourcePoliciesInput struct {

	// The Amazon Resource Names (ARN) of the resources.
	//
	// This member is required.
	ResourceArns []string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The principal.
	Principal *string
}

type GetResourcePoliciesOutput 

type GetResourcePoliciesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// A key policy document, in JSON format.
	Policies []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourcePoliciesPaginator added in v0.30.0 

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

GetResourcePoliciesPaginator is a paginator for GetResourcePolicies

func NewGetResourcePoliciesPaginator added in v0.30.0 

func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator

NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator

func (*GetResourcePoliciesPaginator) HasMorePages added in v0.30.0 

func (p *GetResourcePoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetResourcePoliciesPaginator) NextPage added in v0.30.0 

func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)

NextPage retrieves the next GetResourcePolicies page.

type GetResourcePoliciesPaginatorOptions added in v0.30.0 

type GetResourcePoliciesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

GetResourcePoliciesPaginatorOptions is the paginator options for GetResourcePolicies

type GetResourceShareAssociationsAPIClient added in v0.30.0 

type GetResourceShareAssociationsAPIClient interface {
	GetResourceShareAssociations(context.Context, *GetResourceShareAssociationsInput, ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
}

GetResourceShareAssociationsAPIClient is a client that implements the GetResourceShareAssociations operation.

type GetResourceShareAssociationsInput 

type GetResourceShareAssociationsInput struct {

	// The association type. Specify PRINCIPAL to list the principals that are
	// associated with the specified resource share. Specify RESOURCE to list the
	// resources that are associated with the specified resource share.
	//
	// This member is required.
	AssociationType types.ResourceShareAssociationType

	// The association status.
	AssociationStatus types.ResourceShareAssociationStatus

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The principal. You cannot specify this parameter if the association type is
	// RESOURCE.
	Principal *string

	// The Amazon Resource Name (ARN) of the resource. You cannot specify this
	// parameter if the association type is PRINCIPAL.
	ResourceArn *string

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string
}

type GetResourceShareAssociationsOutput 

type GetResourceShareAssociationsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the associations.
	ResourceShareAssociations []types.ResourceShareAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourceShareAssociationsPaginator added in v0.30.0 

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

GetResourceShareAssociationsPaginator is a paginator for GetResourceShareAssociations

func NewGetResourceShareAssociationsPaginator added in v0.30.0 

func NewGetResourceShareAssociationsPaginator(client GetResourceShareAssociationsAPIClient, params *GetResourceShareAssociationsInput, optFns ...func(*GetResourceShareAssociationsPaginatorOptions)) *GetResourceShareAssociationsPaginator

NewGetResourceShareAssociationsPaginator returns a new GetResourceShareAssociationsPaginator

func (*GetResourceShareAssociationsPaginator) HasMorePages added in v0.30.0 

func (p *GetResourceShareAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetResourceShareAssociationsPaginator) NextPage added in v0.30.0 

func (p *GetResourceShareAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)

NextPage retrieves the next GetResourceShareAssociations page.

type GetResourceShareAssociationsPaginatorOptions added in v0.30.0 

type GetResourceShareAssociationsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

GetResourceShareAssociationsPaginatorOptions is the paginator options for GetResourceShareAssociations

type GetResourceShareInvitationsAPIClient added in v0.30.0 

type GetResourceShareInvitationsAPIClient interface {
	GetResourceShareInvitations(context.Context, *GetResourceShareInvitationsInput, ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
}

GetResourceShareInvitationsAPIClient is a client that implements the GetResourceShareInvitations operation.

type GetResourceShareInvitationsInput 

type GetResourceShareInvitationsInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string

	// The Amazon Resource Names (ARN) of the invitations.
	ResourceShareInvitationArns []string
}

type GetResourceShareInvitationsOutput 

type GetResourceShareInvitationsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the invitations.
	ResourceShareInvitations []types.ResourceShareInvitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourceShareInvitationsPaginator added in v0.30.0 

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

GetResourceShareInvitationsPaginator is a paginator for GetResourceShareInvitations

func NewGetResourceShareInvitationsPaginator added in v0.30.0 

func NewGetResourceShareInvitationsPaginator(client GetResourceShareInvitationsAPIClient, params *GetResourceShareInvitationsInput, optFns ...func(*GetResourceShareInvitationsPaginatorOptions)) *GetResourceShareInvitationsPaginator

NewGetResourceShareInvitationsPaginator returns a new GetResourceShareInvitationsPaginator

func (*GetResourceShareInvitationsPaginator) HasMorePages added in v0.30.0 

func (p *GetResourceShareInvitationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetResourceShareInvitationsPaginator) NextPage added in v0.30.0 

func (p *GetResourceShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)

NextPage retrieves the next GetResourceShareInvitations page.

type GetResourceShareInvitationsPaginatorOptions added in v0.30.0 

type GetResourceShareInvitationsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

GetResourceShareInvitationsPaginatorOptions is the paginator options for GetResourceShareInvitations

type GetResourceSharesAPIClient added in v0.30.0 

type GetResourceSharesAPIClient interface {
	GetResourceShares(context.Context, *GetResourceSharesInput, ...func(*Options)) (*GetResourceSharesOutput, error)
}

GetResourceSharesAPIClient is a client that implements the GetResourceShares operation.

type GetResourceSharesInput 

type GetResourceSharesInput struct {

	// The type of owner.
	//
	// This member is required.
	ResourceOwner types.ResourceOwner

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The name of the resource share.
	Name *string

	// The token for the next page of results.
	NextToken *string

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string

	// The status of the resource share.
	ResourceShareStatus types.ResourceShareStatus

	// One or more tag filters.
	TagFilters []types.TagFilter
}

type GetResourceSharesOutput 

type GetResourceSharesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the resource shares.
	ResourceShares []types.ResourceShare

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetResourceSharesPaginator added in v0.30.0 

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

GetResourceSharesPaginator is a paginator for GetResourceShares

func NewGetResourceSharesPaginator added in v0.30.0 

func NewGetResourceSharesPaginator(client GetResourceSharesAPIClient, params *GetResourceSharesInput, optFns ...func(*GetResourceSharesPaginatorOptions)) *GetResourceSharesPaginator

NewGetResourceSharesPaginator returns a new GetResourceSharesPaginator

func (*GetResourceSharesPaginator) HasMorePages added in v0.30.0 

func (p *GetResourceSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetResourceSharesPaginator) NextPage added in v0.30.0 

func (p *GetResourceSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceSharesOutput, error)

NextPage retrieves the next GetResourceShares page.

type GetResourceSharesPaginatorOptions added in v0.30.0 

type GetResourceSharesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

GetResourceSharesPaginatorOptions is the paginator options for GetResourceShares

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

type ListPendingInvitationResourcesAPIClient interface {
	ListPendingInvitationResources(context.Context, *ListPendingInvitationResourcesInput, ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
}

ListPendingInvitationResourcesAPIClient is a client that implements the ListPendingInvitationResources operation.

type ListPendingInvitationResourcesInput 

type ListPendingInvitationResourcesInput struct {

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

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
}

type ListPendingInvitationResourcesOutput 

type ListPendingInvitationResourcesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the resources included the resource share.
	Resources []types.Resource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPendingInvitationResourcesPaginator added in v0.30.0 

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

ListPendingInvitationResourcesPaginator is a paginator for ListPendingInvitationResources

func NewListPendingInvitationResourcesPaginator added in v0.30.0 

func NewListPendingInvitationResourcesPaginator(client ListPendingInvitationResourcesAPIClient, params *ListPendingInvitationResourcesInput, optFns ...func(*ListPendingInvitationResourcesPaginatorOptions)) *ListPendingInvitationResourcesPaginator

NewListPendingInvitationResourcesPaginator returns a new ListPendingInvitationResourcesPaginator

func (*ListPendingInvitationResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListPendingInvitationResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPendingInvitationResourcesPaginator) NextPage added in v0.30.0 

func (p *ListPendingInvitationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)

NextPage retrieves the next ListPendingInvitationResources page.

type ListPendingInvitationResourcesPaginatorOptions added in v0.30.0 

type ListPendingInvitationResourcesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListPendingInvitationResourcesPaginatorOptions is the paginator options for ListPendingInvitationResources

type ListPermissionsInput 

type ListPermissionsInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// Specifies the resource type for which to list permissions. For example, to list
	// only permissions that apply to EC2 subnets, specify ec2:Subnet.
	ResourceType *string
}

type ListPermissionsOutput 

type ListPermissionsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the permissions.
	Permissions []types.ResourceSharePermissionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPrincipalsAPIClient added in v0.30.0 

type ListPrincipalsAPIClient interface {
	ListPrincipals(context.Context, *ListPrincipalsInput, ...func(*Options)) (*ListPrincipalsOutput, error)
}

ListPrincipalsAPIClient is a client that implements the ListPrincipals operation.

type ListPrincipalsInput 

type ListPrincipalsInput struct {

	// The type of owner.
	//
	// This member is required.
	ResourceOwner types.ResourceOwner

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The principals.
	Principals []string

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string

	// The resource type. Valid values: acm-pca:CertificateAuthority | appmesh:Mesh |
	// codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation |
	// ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet |
	// ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component |
	// imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe |
	// glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration
	// I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup |
	// network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group |
	// rds:Cluster | route53resolver:FirewallRuleGroup
	// |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule
	ResourceType *string
}

type ListPrincipalsOutput 

type ListPrincipalsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The principals.
	Principals []types.Principal

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPrincipalsPaginator added in v0.30.0 

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

ListPrincipalsPaginator is a paginator for ListPrincipals

func NewListPrincipalsPaginator added in v0.30.0 

func NewListPrincipalsPaginator(client ListPrincipalsAPIClient, params *ListPrincipalsInput, optFns ...func(*ListPrincipalsPaginatorOptions)) *ListPrincipalsPaginator

NewListPrincipalsPaginator returns a new ListPrincipalsPaginator

func (*ListPrincipalsPaginator) HasMorePages added in v0.30.0 

func (p *ListPrincipalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPrincipalsPaginator) NextPage added in v0.30.0 

func (p *ListPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsOutput, error)

NextPage retrieves the next ListPrincipals page.

type ListPrincipalsPaginatorOptions added in v0.30.0 

type ListPrincipalsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListPrincipalsPaginatorOptions is the paginator options for ListPrincipals

type ListResourceSharePermissionsInput 

type ListResourceSharePermissionsInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
}

type ListResourceSharePermissionsOutput 

type ListResourceSharePermissionsOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The permissions associated with the resource share.
	Permissions []types.ResourceSharePermissionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourceTypesInput 

type ListResourceTypesInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
}

type ListResourceTypesOutput 

type ListResourceTypesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The shareable resource types supported by AWS RAM.
	ResourceTypes []types.ServiceNameAndResourceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourcesAPIClient added in v0.30.0 

type ListResourcesAPIClient interface {
	ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}

ListResourcesAPIClient is a client that implements the ListResources operation.

type ListResourcesInput 

type ListResourcesInput struct {

	// The type of owner.
	//
	// This member is required.
	ResourceOwner types.ResourceOwner

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string

	// The principal.
	Principal *string

	// The Amazon Resource Names (ARN) of the resources.
	ResourceArns []string

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string

	// The resource type. Valid values: acm-pca:CertificateAuthority | appmesh:Mesh |
	// codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation |
	// ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet |
	// ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component |
	// imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe |
	// glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration
	// I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup |
	// network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group |
	// rds:Cluster | route53resolver:FirewallRuleGroup
	// |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule
	ResourceType *string
}

type ListResourcesOutput 

type ListResourcesOutput struct {

	// The token to use to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the resources.
	Resources []types.Resource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourcesPaginator added in v0.30.0 

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

ListResourcesPaginator is a paginator for ListResources

func NewListResourcesPaginator added in v0.30.0 

func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator

NewListResourcesPaginator returns a new ListResourcesPaginator

func (*ListResourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcesPaginator) NextPage added in v0.30.0 

func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)

NextPage retrieves the next ListResources page.

type ListResourcesPaginatorOptions added in v0.30.0 

type ListResourcesPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

ListResourcesPaginatorOptions is the paginator options for ListResources

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 PromoteResourceShareCreatedFromPolicyInput 

type PromoteResourceShareCreatedFromPolicyInput struct {

	// The ARN of the resource share to promote.
	//
	// This member is required.
	ResourceShareArn *string
}

type PromoteResourceShareCreatedFromPolicyOutput 

type PromoteResourceShareCreatedFromPolicyOutput struct {

	// Indicates whether the request succeeded.
	ReturnValue *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RejectResourceShareInvitationInput 

type RejectResourceShareInvitationInput struct {

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

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string
}

type RejectResourceShareInvitationOutput 

type RejectResourceShareInvitationOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the invitation.
	ResourceShareInvitation *types.ResourceShareInvitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// One or more tags.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// The tag keys of the tags to remove.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateResourceShareInput 

type UpdateResourceShareInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// This member is required.
	ResourceShareArn *string

	// Indicates whether principals outside your AWS organization can be associated
	// with a resource share.
	AllowExternalPrincipals *bool

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// The name of the resource share.
	Name *string
}

type UpdateResourceShareOutput 

type UpdateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string

	// Information about the resource share.
	ResourceShare *types.ResourceShare

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.