ram

package
v0.24.0 Latest Latest
Warning

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

Go to latest
Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 29

Documentation

Overview

Package ram provides the client and types for making API requests to RAM.

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/).

See https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04 for more information on this service.

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

Using the Client

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

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

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

See the RAM client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ram/#New

Index

Constants

View Source
const (
	ServiceName = "RAM" // Service's name
	ServiceID   = "RAM" // Service's identifier
	EndpointsID = "ram" // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeIdempotentParameterMismatchException for service response error code
	// "IdempotentParameterMismatchException".
	//
	// A client token input parameter was reused with an operation, but at least
	// one of the other input parameters is different from the previous call to
	// the operation.
	ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

	// ErrCodeInvalidClientTokenException for service response error code
	// "InvalidClientTokenException".
	//
	// A client token is not valid.
	ErrCodeInvalidClientTokenException = "InvalidClientTokenException"

	// ErrCodeInvalidMaxResultsException for service response error code
	// "InvalidMaxResultsException".
	//
	// The specified value for MaxResults is not valid.
	ErrCodeInvalidMaxResultsException = "InvalidMaxResultsException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The specified value for NextToken is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// A parameter is not valid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidResourceTypeException for service response error code
	// "InvalidResourceTypeException".
	//
	// The specified resource type is not valid.
	ErrCodeInvalidResourceTypeException = "InvalidResourceTypeException"

	// ErrCodeInvalidStateTransitionException for service response error code
	// "InvalidStateTransitionException".
	//
	// The requested state transition is not valid.
	ErrCodeInvalidStateTransitionException = "InvalidStateTransitionException"

	// ErrCodeMalformedArnException for service response error code
	// "MalformedArnException".
	//
	// The format of an Amazon Resource Name (ARN) is not valid.
	ErrCodeMalformedArnException = "MalformedArnException"

	// ErrCodeMissingRequiredParameterException for service response error code
	// "MissingRequiredParameterException".
	//
	// A required input parameter is missing.
	ErrCodeMissingRequiredParameterException = "MissingRequiredParameterException"

	// ErrCodeOperationNotPermittedException for service response error code
	// "OperationNotPermittedException".
	//
	// The requested operation is not permitted.
	ErrCodeOperationNotPermittedException = "OperationNotPermittedException"

	// ErrCodeResourceArnNotFoundException for service response error code
	// "ResourceArnNotFoundException".
	//
	// An Amazon Resource Name (ARN) was not found.
	ErrCodeResourceArnNotFoundException = "ResourceArnNotFoundException"

	// ErrCodeResourceShareInvitationAlreadyAcceptedException for service response error code
	// "ResourceShareInvitationAlreadyAcceptedException".
	//
	// The invitation was already accepted.
	ErrCodeResourceShareInvitationAlreadyAcceptedException = "ResourceShareInvitationAlreadyAcceptedException"

	// ErrCodeResourceShareInvitationAlreadyRejectedException for service response error code
	// "ResourceShareInvitationAlreadyRejectedException".
	//
	// The invitation was already rejected.
	ErrCodeResourceShareInvitationAlreadyRejectedException = "ResourceShareInvitationAlreadyRejectedException"

	// ErrCodeResourceShareInvitationArnNotFoundException for service response error code
	// "ResourceShareInvitationArnNotFoundException".
	//
	// The Amazon Resource Name (ARN) for an invitation was not found.
	ErrCodeResourceShareInvitationArnNotFoundException = "ResourceShareInvitationArnNotFoundException"

	// ErrCodeResourceShareInvitationExpiredException for service response error code
	// "ResourceShareInvitationExpiredException".
	//
	// The invitation is expired.
	ErrCodeResourceShareInvitationExpiredException = "ResourceShareInvitationExpiredException"

	// ErrCodeResourceShareLimitExceededException for service response error code
	// "ResourceShareLimitExceededException".
	//
	// The requested resource share exceeds the limit for your account.
	ErrCodeResourceShareLimitExceededException = "ResourceShareLimitExceededException"

	// ErrCodeServerInternalException for service response error code
	// "ServerInternalException".
	//
	// The service could not respond to the request due to an internal problem.
	ErrCodeServerInternalException = "ServerInternalException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is not available.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTagLimitExceededException for service response error code
	// "TagLimitExceededException".
	//
	// The requested tags exceed the limit for your account.
	ErrCodeTagLimitExceededException = "TagLimitExceededException"

	// ErrCodeTagPolicyViolationException for service response error code
	// "TagPolicyViolationException".
	//
	// The specified tag is a reserved word and cannot be used.
	ErrCodeTagPolicyViolationException = "TagPolicyViolationException"

	// ErrCodeUnknownResourceException for service response error code
	// "UnknownResourceException".
	//
	// A specified resource was not found.
	ErrCodeUnknownResourceException = "UnknownResourceException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AcceptResourceShareInvitationInput

type AcceptResourceShareInvitationInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The Amazon Resource Name (ARN) of the invitation.
	//
	// ResourceShareInvitationArn is a required field
	ResourceShareInvitationArn *string `locationName:"resourceShareInvitationArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AcceptResourceShareInvitationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AcceptResourceShareInvitationInput) String

String returns the string representation

func (*AcceptResourceShareInvitationInput) Validate

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

type AcceptResourceShareInvitationOutput

type AcceptResourceShareInvitationOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the invitation.
	ResourceShareInvitation *ResourceShareInvitation `locationName:"resourceShareInvitation" type:"structure"`
	// contains filtered or unexported fields
}

func (AcceptResourceShareInvitationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AcceptResourceShareInvitationOutput) String

String returns the string representation

type AcceptResourceShareInvitationRequest

type AcceptResourceShareInvitationRequest struct {
	*aws.Request
	Input *AcceptResourceShareInvitationInput
	Copy  func(*AcceptResourceShareInvitationInput) AcceptResourceShareInvitationRequest
}

AcceptResourceShareInvitationRequest is the request type for the AcceptResourceShareInvitation API operation.

func (AcceptResourceShareInvitationRequest) Send

Send marshals and sends the AcceptResourceShareInvitation API request.

type AcceptResourceShareInvitationResponse added in v0.9.0

type AcceptResourceShareInvitationResponse struct {
	*AcceptResourceShareInvitationOutput
	// contains filtered or unexported fields
}

AcceptResourceShareInvitationResponse is the response type for the AcceptResourceShareInvitation API operation.

func (*AcceptResourceShareInvitationResponse) SDKResponseMetdata added in v0.9.0

func (r *AcceptResourceShareInvitationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AcceptResourceShareInvitation request.

type AssociateResourceShareInput

type AssociateResourceShareInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The principals.
	Principals []string `locationName:"principals" type:"list"`

	// The Amazon Resource Names (ARN) of the resources.
	ResourceArns []string `locationName:"resourceArns" type:"list"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateResourceShareInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateResourceShareInput) String

String returns the string representation

func (*AssociateResourceShareInput) Validate

func (s *AssociateResourceShareInput) Validate() error

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

type AssociateResourceShareOutput

type AssociateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the associations.
	ResourceShareAssociations []ResourceShareAssociation `locationName:"resourceShareAssociations" type:"list"`
	// contains filtered or unexported fields
}

func (AssociateResourceShareOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateResourceShareOutput) String

String returns the string representation

type AssociateResourceSharePermissionInput added in v0.18.0

type AssociateResourceSharePermissionInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The ARN of the AWS RAM permission to associate with the resource share.
	//
	// PermissionArn is a required field
	PermissionArn *string `locationName:"permissionArn" type:"string" required:"true"`

	// 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 `locationName:"replace" type:"boolean"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateResourceSharePermissionInput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateResourceSharePermissionInput) String added in v0.18.0

String returns the string representation

func (*AssociateResourceSharePermissionInput) Validate added in v0.18.0

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

type AssociateResourceSharePermissionOutput added in v0.18.0

type AssociateResourceSharePermissionOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Indicates whether the request succeeded.
	ReturnValue *bool `locationName:"returnValue" type:"boolean"`
	// contains filtered or unexported fields
}

func (AssociateResourceSharePermissionOutput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateResourceSharePermissionOutput) String added in v0.18.0

String returns the string representation

type AssociateResourceSharePermissionRequest added in v0.18.0

type AssociateResourceSharePermissionRequest struct {
	*aws.Request
	Input *AssociateResourceSharePermissionInput
	Copy  func(*AssociateResourceSharePermissionInput) AssociateResourceSharePermissionRequest
}

AssociateResourceSharePermissionRequest is the request type for the AssociateResourceSharePermission API operation.

func (AssociateResourceSharePermissionRequest) Send added in v0.18.0

Send marshals and sends the AssociateResourceSharePermission API request.

type AssociateResourceSharePermissionResponse added in v0.18.0

type AssociateResourceSharePermissionResponse struct {
	*AssociateResourceSharePermissionOutput
	// contains filtered or unexported fields
}

AssociateResourceSharePermissionResponse is the response type for the AssociateResourceSharePermission API operation.

func (*AssociateResourceSharePermissionResponse) SDKResponseMetdata added in v0.18.0

func (r *AssociateResourceSharePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateResourceSharePermission request.

type AssociateResourceShareRequest

type AssociateResourceShareRequest struct {
	*aws.Request
	Input *AssociateResourceShareInput
	Copy  func(*AssociateResourceShareInput) AssociateResourceShareRequest
}

AssociateResourceShareRequest is the request type for the AssociateResourceShare API operation.

func (AssociateResourceShareRequest) Send

Send marshals and sends the AssociateResourceShare API request.

type AssociateResourceShareResponse added in v0.9.0

type AssociateResourceShareResponse struct {
	*AssociateResourceShareOutput
	// contains filtered or unexported fields
}

AssociateResourceShareResponse is the response type for the AssociateResourceShare API operation.

func (*AssociateResourceShareResponse) SDKResponseMetdata added in v0.9.0

func (r *AssociateResourceShareResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateResourceShare request.

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to RAM. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := ram.New(myConfig)

func (*Client) AcceptResourceShareInvitationRequest added in v0.9.0

func (c *Client) AcceptResourceShareInvitationRequest(input *AcceptResourceShareInvitationInput) AcceptResourceShareInvitationRequest

AcceptResourceShareInvitationRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using AcceptResourceShareInvitationRequest.
req := client.AcceptResourceShareInvitationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AcceptResourceShareInvitation

func (*Client) AssociateResourceSharePermissionRequest added in v0.18.0

func (c *Client) AssociateResourceSharePermissionRequest(input *AssociateResourceSharePermissionInput) AssociateResourceSharePermissionRequest

AssociateResourceSharePermissionRequest returns a request value for making API operation for AWS Resource Access Manager.

Associates a permission with a resource share.

// Example sending a request using AssociateResourceSharePermissionRequest.
req := client.AssociateResourceSharePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceSharePermission

func (*Client) AssociateResourceShareRequest added in v0.9.0

func (c *Client) AssociateResourceShareRequest(input *AssociateResourceShareInput) AssociateResourceShareRequest

AssociateResourceShareRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using AssociateResourceShareRequest.
req := client.AssociateResourceShareRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/AssociateResourceShare

func (*Client) CreateResourceShareRequest added in v0.9.0

func (c *Client) CreateResourceShareRequest(input *CreateResourceShareInput) CreateResourceShareRequest

CreateResourceShareRequest returns a request value for making API operation for AWS Resource Access Manager.

Creates a resource share.

// Example sending a request using CreateResourceShareRequest.
req := client.CreateResourceShareRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/CreateResourceShare

func (*Client) DeleteResourceShareRequest added in v0.9.0

func (c *Client) DeleteResourceShareRequest(input *DeleteResourceShareInput) DeleteResourceShareRequest

DeleteResourceShareRequest returns a request value for making API operation for AWS Resource Access Manager.

Deletes the specified resource share.

// Example sending a request using DeleteResourceShareRequest.
req := client.DeleteResourceShareRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DeleteResourceShare

func (*Client) DisassociateResourceSharePermissionRequest added in v0.18.0

func (c *Client) DisassociateResourceSharePermissionRequest(input *DisassociateResourceSharePermissionInput) DisassociateResourceSharePermissionRequest

DisassociateResourceSharePermissionRequest returns a request value for making API operation for AWS Resource Access Manager.

Disassociates an AWS RAM permission from a resource share.

// Example sending a request using DisassociateResourceSharePermissionRequest.
req := client.DisassociateResourceSharePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceSharePermission

func (*Client) DisassociateResourceShareRequest added in v0.9.0

func (c *Client) DisassociateResourceShareRequest(input *DisassociateResourceShareInput) DisassociateResourceShareRequest

DisassociateResourceShareRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using DisassociateResourceShareRequest.
req := client.DisassociateResourceShareRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/DisassociateResourceShare

func (*Client) EnableSharingWithAwsOrganizationRequest added in v0.9.0

func (c *Client) EnableSharingWithAwsOrganizationRequest(input *EnableSharingWithAwsOrganizationInput) EnableSharingWithAwsOrganizationRequest

EnableSharingWithAwsOrganizationRequest returns a request value for making API operation for AWS Resource Access Manager.

Enables resource sharing within your AWS Organization.

The caller must be the master account for the AWS Organization.

// Example sending a request using EnableSharingWithAwsOrganizationRequest.
req := client.EnableSharingWithAwsOrganizationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/EnableSharingWithAwsOrganization

func (*Client) GetPermissionRequest added in v0.18.0

func (c *Client) GetPermissionRequest(input *GetPermissionInput) GetPermissionRequest

GetPermissionRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using GetPermissionRequest.
req := client.GetPermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetPermission

func (*Client) GetResourcePoliciesRequest added in v0.9.0

func (c *Client) GetResourcePoliciesRequest(input *GetResourcePoliciesInput) GetResourcePoliciesRequest

GetResourcePoliciesRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using GetResourcePoliciesRequest.
req := client.GetResourcePoliciesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourcePolicies

func (*Client) GetResourceShareAssociationsRequest added in v0.9.0

func (c *Client) GetResourceShareAssociationsRequest(input *GetResourceShareAssociationsInput) GetResourceShareAssociationsRequest

GetResourceShareAssociationsRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using GetResourceShareAssociationsRequest.
req := client.GetResourceShareAssociationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareAssociations

func (*Client) GetResourceShareInvitationsRequest added in v0.9.0

func (c *Client) GetResourceShareInvitationsRequest(input *GetResourceShareInvitationsInput) GetResourceShareInvitationsRequest

GetResourceShareInvitationsRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using GetResourceShareInvitationsRequest.
req := client.GetResourceShareInvitationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShareInvitations

func (*Client) GetResourceSharesRequest added in v0.9.0

func (c *Client) GetResourceSharesRequest(input *GetResourceSharesInput) GetResourceSharesRequest

GetResourceSharesRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using GetResourceSharesRequest.
req := client.GetResourceSharesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/GetResourceShares

func (*Client) ListPendingInvitationResourcesRequest added in v0.13.0

func (c *Client) ListPendingInvitationResourcesRequest(input *ListPendingInvitationResourcesInput) ListPendingInvitationResourcesRequest

ListPendingInvitationResourcesRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using ListPendingInvitationResourcesRequest.
req := client.ListPendingInvitationResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPendingInvitationResources

func (*Client) ListPermissionsRequest added in v0.18.0

func (c *Client) ListPermissionsRequest(input *ListPermissionsInput) ListPermissionsRequest

ListPermissionsRequest returns a request value for making API operation for AWS Resource Access Manager.

Lists the AWS RAM permissions.

// Example sending a request using ListPermissionsRequest.
req := client.ListPermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPermissions

func (*Client) ListPrincipalsRequest added in v0.9.0

func (c *Client) ListPrincipalsRequest(input *ListPrincipalsInput) ListPrincipalsRequest

ListPrincipalsRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using ListPrincipalsRequest.
req := client.ListPrincipalsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListPrincipals

func (*Client) ListResourceSharePermissionsRequest added in v0.18.0

func (c *Client) ListResourceSharePermissionsRequest(input *ListResourceSharePermissionsInput) ListResourceSharePermissionsRequest

ListResourceSharePermissionsRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using ListResourceSharePermissionsRequest.
req := client.ListResourceSharePermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceSharePermissions

func (*Client) ListResourceTypesRequest added in v0.22.0

func (c *Client) ListResourceTypesRequest(input *ListResourceTypesInput) ListResourceTypesRequest

ListResourceTypesRequest returns a request value for making API operation for AWS Resource Access Manager.

Lists the shareable resource types supported by AWS RAM.

// Example sending a request using ListResourceTypesRequest.
req := client.ListResourceTypesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResourceTypes

func (*Client) ListResourcesRequest added in v0.9.0

func (c *Client) ListResourcesRequest(input *ListResourcesInput) ListResourcesRequest

ListResourcesRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using ListResourcesRequest.
req := client.ListResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/ListResources

func (*Client) PromoteResourceShareCreatedFromPolicyRequest added in v0.18.0

func (c *Client) PromoteResourceShareCreatedFromPolicyRequest(input *PromoteResourceShareCreatedFromPolicyInput) PromoteResourceShareCreatedFromPolicyRequest

PromoteResourceShareCreatedFromPolicyRequest returns a request value for making API operation for AWS Resource Access Manager.

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.

    // Example sending a request using PromoteResourceShareCreatedFromPolicyRequest. req := client.PromoteResourceShareCreatedFromPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/PromoteResourceShareCreatedFromPolicy

func (*Client) RejectResourceShareInvitationRequest added in v0.9.0

func (c *Client) RejectResourceShareInvitationRequest(input *RejectResourceShareInvitationInput) RejectResourceShareInvitationRequest

RejectResourceShareInvitationRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using RejectResourceShareInvitationRequest.
req := client.RejectResourceShareInvitationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/RejectResourceShareInvitation

func (*Client) TagResourceRequest added in v0.9.0

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/TagResource

func (*Client) UntagResourceRequest added in v0.9.0

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS Resource Access Manager.

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

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UntagResource

func (*Client) UpdateResourceShareRequest added in v0.9.0

func (c *Client) UpdateResourceShareRequest(input *UpdateResourceShareInput) UpdateResourceShareRequest

UpdateResourceShareRequest returns a request value for making API operation for AWS Resource Access Manager.

Updates the specified resource share that you own.

// Example sending a request using UpdateResourceShareRequest.
req := client.UpdateResourceShareRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ram-2018-01-04/UpdateResourceShare

type CreateResourceShareInput

type CreateResourceShareInput struct {

	// Indicates whether principals outside your AWS organization can be associated
	// with a resource share.
	AllowExternalPrincipals *bool `locationName:"allowExternalPrincipals" type:"boolean"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The name of the resource share.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// 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 `locationName:"permissionArns" type:"list"`

	// 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 `locationName:"principals" type:"list"`

	// The Amazon Resource Names (ARN) of the resources to associate with the resource
	// share.
	ResourceArns []string `locationName:"resourceArns" type:"list"`

	// One or more tags.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

func (CreateResourceShareInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateResourceShareInput) String

func (s CreateResourceShareInput) String() string

String returns the string representation

func (*CreateResourceShareInput) Validate

func (s *CreateResourceShareInput) Validate() error

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

type CreateResourceShareOutput

type CreateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the resource share.
	ResourceShare *ResourceShare `locationName:"resourceShare" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateResourceShareOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateResourceShareOutput) String

func (s CreateResourceShareOutput) String() string

String returns the string representation

type CreateResourceShareRequest

type CreateResourceShareRequest struct {
	*aws.Request
	Input *CreateResourceShareInput
	Copy  func(*CreateResourceShareInput) CreateResourceShareRequest
}

CreateResourceShareRequest is the request type for the CreateResourceShare API operation.

func (CreateResourceShareRequest) Send

Send marshals and sends the CreateResourceShare API request.

type CreateResourceShareResponse added in v0.9.0

type CreateResourceShareResponse struct {
	*CreateResourceShareOutput
	// contains filtered or unexported fields
}

CreateResourceShareResponse is the response type for the CreateResourceShare API operation.

func (*CreateResourceShareResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateResourceShareResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateResourceShare request.

type DeleteResourceShareInput

type DeleteResourceShareInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `location:"querystring" locationName:"clientToken" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `location:"querystring" locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourceShareInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteResourceShareInput) String

func (s DeleteResourceShareInput) String() string

String returns the string representation

func (*DeleteResourceShareInput) Validate

func (s *DeleteResourceShareInput) Validate() error

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

type DeleteResourceShareOutput

type DeleteResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Indicates whether the request succeeded.
	ReturnValue *bool `locationName:"returnValue" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteResourceShareOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteResourceShareOutput) String

func (s DeleteResourceShareOutput) String() string

String returns the string representation

type DeleteResourceShareRequest

type DeleteResourceShareRequest struct {
	*aws.Request
	Input *DeleteResourceShareInput
	Copy  func(*DeleteResourceShareInput) DeleteResourceShareRequest
}

DeleteResourceShareRequest is the request type for the DeleteResourceShare API operation.

func (DeleteResourceShareRequest) Send

Send marshals and sends the DeleteResourceShare API request.

type DeleteResourceShareResponse added in v0.9.0

type DeleteResourceShareResponse struct {
	*DeleteResourceShareOutput
	// contains filtered or unexported fields
}

DeleteResourceShareResponse is the response type for the DeleteResourceShare API operation.

func (*DeleteResourceShareResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteResourceShareResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteResourceShare request.

type DisassociateResourceShareInput

type DisassociateResourceShareInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The principals.
	Principals []string `locationName:"principals" type:"list"`

	// The Amazon Resource Names (ARNs) of the resources.
	ResourceArns []string `locationName:"resourceArns" type:"list"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateResourceShareInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateResourceShareInput) String

String returns the string representation

func (*DisassociateResourceShareInput) Validate

func (s *DisassociateResourceShareInput) Validate() error

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

type DisassociateResourceShareOutput

type DisassociateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the associations.
	ResourceShareAssociations []ResourceShareAssociation `locationName:"resourceShareAssociations" type:"list"`
	// contains filtered or unexported fields
}

func (DisassociateResourceShareOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateResourceShareOutput) String

String returns the string representation

type DisassociateResourceSharePermissionInput added in v0.18.0

type DisassociateResourceSharePermissionInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The ARN of the permission to disassociate from the resource share.
	//
	// PermissionArn is a required field
	PermissionArn *string `locationName:"permissionArn" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateResourceSharePermissionInput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateResourceSharePermissionInput) String added in v0.18.0

String returns the string representation

func (*DisassociateResourceSharePermissionInput) Validate added in v0.18.0

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

type DisassociateResourceSharePermissionOutput added in v0.18.0

type DisassociateResourceSharePermissionOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Indicates whether the request succeeded.
	ReturnValue *bool `locationName:"returnValue" type:"boolean"`
	// contains filtered or unexported fields
}

func (DisassociateResourceSharePermissionOutput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateResourceSharePermissionOutput) String added in v0.18.0

String returns the string representation

type DisassociateResourceSharePermissionRequest added in v0.18.0

DisassociateResourceSharePermissionRequest is the request type for the DisassociateResourceSharePermission API operation.

func (DisassociateResourceSharePermissionRequest) Send added in v0.18.0

Send marshals and sends the DisassociateResourceSharePermission API request.

type DisassociateResourceSharePermissionResponse added in v0.18.0

type DisassociateResourceSharePermissionResponse struct {
	*DisassociateResourceSharePermissionOutput
	// contains filtered or unexported fields
}

DisassociateResourceSharePermissionResponse is the response type for the DisassociateResourceSharePermission API operation.

func (*DisassociateResourceSharePermissionResponse) SDKResponseMetdata added in v0.18.0

func (r *DisassociateResourceSharePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateResourceSharePermission request.

type DisassociateResourceShareRequest

type DisassociateResourceShareRequest struct {
	*aws.Request
	Input *DisassociateResourceShareInput
	Copy  func(*DisassociateResourceShareInput) DisassociateResourceShareRequest
}

DisassociateResourceShareRequest is the request type for the DisassociateResourceShare API operation.

func (DisassociateResourceShareRequest) Send

Send marshals and sends the DisassociateResourceShare API request.

type DisassociateResourceShareResponse added in v0.9.0

type DisassociateResourceShareResponse struct {
	*DisassociateResourceShareOutput
	// contains filtered or unexported fields
}

DisassociateResourceShareResponse is the response type for the DisassociateResourceShare API operation.

func (*DisassociateResourceShareResponse) SDKResponseMetdata added in v0.9.0

func (r *DisassociateResourceShareResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateResourceShare request.

type EnableSharingWithAwsOrganizationInput

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

func (EnableSharingWithAwsOrganizationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EnableSharingWithAwsOrganizationInput) String

String returns the string representation

type EnableSharingWithAwsOrganizationOutput

type EnableSharingWithAwsOrganizationOutput struct {

	// Indicates whether the request succeeded.
	ReturnValue *bool `locationName:"returnValue" type:"boolean"`
	// contains filtered or unexported fields
}

func (EnableSharingWithAwsOrganizationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EnableSharingWithAwsOrganizationOutput) String

String returns the string representation

type EnableSharingWithAwsOrganizationRequest

type EnableSharingWithAwsOrganizationRequest struct {
	*aws.Request
	Input *EnableSharingWithAwsOrganizationInput
	Copy  func(*EnableSharingWithAwsOrganizationInput) EnableSharingWithAwsOrganizationRequest
}

EnableSharingWithAwsOrganizationRequest is the request type for the EnableSharingWithAwsOrganization API operation.

func (EnableSharingWithAwsOrganizationRequest) Send

Send marshals and sends the EnableSharingWithAwsOrganization API request.

type EnableSharingWithAwsOrganizationResponse added in v0.9.0

type EnableSharingWithAwsOrganizationResponse struct {
	*EnableSharingWithAwsOrganizationOutput
	// contains filtered or unexported fields
}

EnableSharingWithAwsOrganizationResponse is the response type for the EnableSharingWithAwsOrganization API operation.

func (*EnableSharingWithAwsOrganizationResponse) SDKResponseMetdata added in v0.9.0

func (r *EnableSharingWithAwsOrganizationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the EnableSharingWithAwsOrganization request.

type GetPermissionInput added in v0.18.0

type GetPermissionInput struct {

	// The ARN of the permission.
	//
	// PermissionArn is a required field
	PermissionArn *string `locationName:"permissionArn" type:"string" required:"true"`

	// The identifier for the version of the permission.
	PermissionVersion *int64 `locationName:"permissionVersion" type:"integer"`
	// contains filtered or unexported fields
}

func (GetPermissionInput) MarshalFields added in v0.18.0

func (s GetPermissionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPermissionInput) String added in v0.18.0

func (s GetPermissionInput) String() string

String returns the string representation

func (*GetPermissionInput) Validate added in v0.18.0

func (s *GetPermissionInput) Validate() error

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

type GetPermissionOutput added in v0.18.0

type GetPermissionOutput struct {

	// Information about the permission.
	Permission *ResourceSharePermissionDetail `locationName:"permission" type:"structure"`
	// contains filtered or unexported fields
}

func (GetPermissionOutput) MarshalFields added in v0.18.0

func (s GetPermissionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPermissionOutput) String added in v0.18.0

func (s GetPermissionOutput) String() string

String returns the string representation

type GetPermissionRequest added in v0.18.0

type GetPermissionRequest struct {
	*aws.Request
	Input *GetPermissionInput
	Copy  func(*GetPermissionInput) GetPermissionRequest
}

GetPermissionRequest is the request type for the GetPermission API operation.

func (GetPermissionRequest) Send added in v0.18.0

Send marshals and sends the GetPermission API request.

type GetPermissionResponse added in v0.18.0

type GetPermissionResponse struct {
	*GetPermissionOutput
	// contains filtered or unexported fields
}

GetPermissionResponse is the response type for the GetPermission API operation.

func (*GetPermissionResponse) SDKResponseMetdata added in v0.18.0

func (r *GetPermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPermission request.

type GetResourcePoliciesInput

type GetResourcePoliciesInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The principal.
	Principal *string `locationName:"principal" type:"string"`

	// The Amazon Resource Names (ARN) of the resources.
	//
	// ResourceArns is a required field
	ResourceArns []string `locationName:"resourceArns" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetResourcePoliciesInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourcePoliciesInput) String

func (s GetResourcePoliciesInput) String() string

String returns the string representation

func (*GetResourcePoliciesInput) Validate

func (s *GetResourcePoliciesInput) Validate() error

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

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 `locationName:"nextToken" type:"string"`

	// A key policy document, in JSON format.
	Policies []string `locationName:"policies" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourcePoliciesOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourcePoliciesOutput) String

func (s GetResourcePoliciesOutput) String() string

String returns the string representation

type GetResourcePoliciesPaginator added in v0.9.0

type GetResourcePoliciesPaginator struct {
	aws.Pager
}

GetResourcePoliciesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetResourcePoliciesPaginator added in v0.9.0

func NewGetResourcePoliciesPaginator(req GetResourcePoliciesRequest) GetResourcePoliciesPaginator

NewGetResourcePoliciesRequestPaginator returns a paginator for GetResourcePolicies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.GetResourcePoliciesRequest(input)
p := ram.NewGetResourcePoliciesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetResourcePoliciesPaginator) CurrentPage added in v0.9.0

type GetResourcePoliciesRequest

type GetResourcePoliciesRequest struct {
	*aws.Request
	Input *GetResourcePoliciesInput
	Copy  func(*GetResourcePoliciesInput) GetResourcePoliciesRequest
}

GetResourcePoliciesRequest is the request type for the GetResourcePolicies API operation.

func (GetResourcePoliciesRequest) Send

Send marshals and sends the GetResourcePolicies API request.

type GetResourcePoliciesResponse added in v0.9.0

type GetResourcePoliciesResponse struct {
	*GetResourcePoliciesOutput
	// contains filtered or unexported fields
}

GetResourcePoliciesResponse is the response type for the GetResourcePolicies API operation.

func (*GetResourcePoliciesResponse) SDKResponseMetdata added in v0.9.0

func (r *GetResourcePoliciesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResourcePolicies request.

type GetResourceShareAssociationsInput

type GetResourceShareAssociationsInput struct {

	// The association status.
	AssociationStatus ResourceShareAssociationStatus `locationName:"associationStatus" type:"string" enum:"true"`

	// 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.
	//
	// AssociationType is a required field
	AssociationType ResourceShareAssociationType `locationName:"associationType" type:"string" required:"true" enum:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

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

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

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string `locationName:"resourceShareArns" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceShareAssociationsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceShareAssociationsInput) String

String returns the string representation

func (*GetResourceShareAssociationsInput) Validate

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

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 `locationName:"nextToken" type:"string"`

	// Information about the associations.
	ResourceShareAssociations []ResourceShareAssociation `locationName:"resourceShareAssociations" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceShareAssociationsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceShareAssociationsOutput) String

String returns the string representation

type GetResourceShareAssociationsPaginator added in v0.9.0

type GetResourceShareAssociationsPaginator struct {
	aws.Pager
}

GetResourceShareAssociationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetResourceShareAssociationsPaginator added in v0.9.0

func NewGetResourceShareAssociationsPaginator(req GetResourceShareAssociationsRequest) GetResourceShareAssociationsPaginator

NewGetResourceShareAssociationsRequestPaginator returns a paginator for GetResourceShareAssociations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.GetResourceShareAssociationsRequest(input)
p := ram.NewGetResourceShareAssociationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetResourceShareAssociationsPaginator) CurrentPage added in v0.9.0

type GetResourceShareAssociationsRequest

type GetResourceShareAssociationsRequest struct {
	*aws.Request
	Input *GetResourceShareAssociationsInput
	Copy  func(*GetResourceShareAssociationsInput) GetResourceShareAssociationsRequest
}

GetResourceShareAssociationsRequest is the request type for the GetResourceShareAssociations API operation.

func (GetResourceShareAssociationsRequest) Send

Send marshals and sends the GetResourceShareAssociations API request.

type GetResourceShareAssociationsResponse added in v0.9.0

type GetResourceShareAssociationsResponse struct {
	*GetResourceShareAssociationsOutput
	// contains filtered or unexported fields
}

GetResourceShareAssociationsResponse is the response type for the GetResourceShareAssociations API operation.

func (*GetResourceShareAssociationsResponse) SDKResponseMetdata added in v0.9.0

func (r *GetResourceShareAssociationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResourceShareAssociations request.

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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string `locationName:"resourceShareArns" type:"list"`

	// The Amazon Resource Names (ARN) of the invitations.
	ResourceShareInvitationArns []string `locationName:"resourceShareInvitationArns" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceShareInvitationsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceShareInvitationsInput) String

String returns the string representation

func (*GetResourceShareInvitationsInput) Validate

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

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 `locationName:"nextToken" type:"string"`

	// Information about the invitations.
	ResourceShareInvitations []ResourceShareInvitation `locationName:"resourceShareInvitations" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceShareInvitationsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceShareInvitationsOutput) String

String returns the string representation

type GetResourceShareInvitationsPaginator added in v0.9.0

type GetResourceShareInvitationsPaginator struct {
	aws.Pager
}

GetResourceShareInvitationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetResourceShareInvitationsPaginator added in v0.9.0

func NewGetResourceShareInvitationsPaginator(req GetResourceShareInvitationsRequest) GetResourceShareInvitationsPaginator

NewGetResourceShareInvitationsRequestPaginator returns a paginator for GetResourceShareInvitations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.GetResourceShareInvitationsRequest(input)
p := ram.NewGetResourceShareInvitationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetResourceShareInvitationsPaginator) CurrentPage added in v0.9.0

type GetResourceShareInvitationsRequest

type GetResourceShareInvitationsRequest struct {
	*aws.Request
	Input *GetResourceShareInvitationsInput
	Copy  func(*GetResourceShareInvitationsInput) GetResourceShareInvitationsRequest
}

GetResourceShareInvitationsRequest is the request type for the GetResourceShareInvitations API operation.

func (GetResourceShareInvitationsRequest) Send

Send marshals and sends the GetResourceShareInvitations API request.

type GetResourceShareInvitationsResponse added in v0.9.0

type GetResourceShareInvitationsResponse struct {
	*GetResourceShareInvitationsOutput
	// contains filtered or unexported fields
}

GetResourceShareInvitationsResponse is the response type for the GetResourceShareInvitations API operation.

func (*GetResourceShareInvitationsResponse) SDKResponseMetdata added in v0.9.0

func (r *GetResourceShareInvitationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResourceShareInvitations request.

type GetResourceSharesInput

type GetResourceSharesInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The name of the resource share.
	Name *string `locationName:"name" type:"string"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The type of owner.
	//
	// ResourceOwner is a required field
	ResourceOwner ResourceOwner `locationName:"resourceOwner" type:"string" required:"true" enum:"true"`

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string `locationName:"resourceShareArns" type:"list"`

	// The status of the resource share.
	ResourceShareStatus ResourceShareStatus `locationName:"resourceShareStatus" type:"string" enum:"true"`

	// One or more tag filters.
	TagFilters []TagFilter `locationName:"tagFilters" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceSharesInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceSharesInput) String

func (s GetResourceSharesInput) String() string

String returns the string representation

func (*GetResourceSharesInput) Validate

func (s *GetResourceSharesInput) Validate() error

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

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 `locationName:"nextToken" type:"string"`

	// Information about the resource shares.
	ResourceShares []ResourceShare `locationName:"resourceShares" type:"list"`
	// contains filtered or unexported fields
}

func (GetResourceSharesOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetResourceSharesOutput) String

func (s GetResourceSharesOutput) String() string

String returns the string representation

type GetResourceSharesPaginator added in v0.9.0

type GetResourceSharesPaginator struct {
	aws.Pager
}

GetResourceSharesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetResourceSharesPaginator added in v0.9.0

func NewGetResourceSharesPaginator(req GetResourceSharesRequest) GetResourceSharesPaginator

NewGetResourceSharesRequestPaginator returns a paginator for GetResourceShares. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.GetResourceSharesRequest(input)
p := ram.NewGetResourceSharesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetResourceSharesPaginator) CurrentPage added in v0.9.0

type GetResourceSharesRequest

type GetResourceSharesRequest struct {
	*aws.Request
	Input *GetResourceSharesInput
	Copy  func(*GetResourceSharesInput) GetResourceSharesRequest
}

GetResourceSharesRequest is the request type for the GetResourceShares API operation.

func (GetResourceSharesRequest) Send

Send marshals and sends the GetResourceShares API request.

type GetResourceSharesResponse added in v0.9.0

type GetResourceSharesResponse struct {
	*GetResourceSharesOutput
	// contains filtered or unexported fields
}

GetResourceSharesResponse is the response type for the GetResourceShares API operation.

func (*GetResourceSharesResponse) SDKResponseMetdata added in v0.9.0

func (r *GetResourceSharesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetResourceShares request.

type ListPendingInvitationResourcesInput added in v0.13.0

type ListPendingInvitationResourcesInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the invitation.
	//
	// ResourceShareInvitationArn is a required field
	ResourceShareInvitationArn *string `locationName:"resourceShareInvitationArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPendingInvitationResourcesInput) MarshalFields added in v0.13.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPendingInvitationResourcesInput) String added in v0.13.0

String returns the string representation

func (*ListPendingInvitationResourcesInput) Validate added in v0.13.0

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

type ListPendingInvitationResourcesOutput added in v0.13.0

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 `locationName:"nextToken" type:"string"`

	// Information about the resources included the resource share.
	Resources []Resource `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

func (ListPendingInvitationResourcesOutput) MarshalFields added in v0.13.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPendingInvitationResourcesOutput) String added in v0.13.0

String returns the string representation

type ListPendingInvitationResourcesPaginator added in v0.13.0

type ListPendingInvitationResourcesPaginator struct {
	aws.Pager
}

ListPendingInvitationResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPendingInvitationResourcesPaginator added in v0.13.0

func NewListPendingInvitationResourcesPaginator(req ListPendingInvitationResourcesRequest) ListPendingInvitationResourcesPaginator

NewListPendingInvitationResourcesRequestPaginator returns a paginator for ListPendingInvitationResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListPendingInvitationResourcesRequest(input)
p := ram.NewListPendingInvitationResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPendingInvitationResourcesPaginator) CurrentPage added in v0.13.0

type ListPendingInvitationResourcesRequest added in v0.13.0

type ListPendingInvitationResourcesRequest struct {
	*aws.Request
	Input *ListPendingInvitationResourcesInput
	Copy  func(*ListPendingInvitationResourcesInput) ListPendingInvitationResourcesRequest
}

ListPendingInvitationResourcesRequest is the request type for the ListPendingInvitationResources API operation.

func (ListPendingInvitationResourcesRequest) Send added in v0.13.0

Send marshals and sends the ListPendingInvitationResources API request.

type ListPendingInvitationResourcesResponse added in v0.13.0

type ListPendingInvitationResourcesResponse struct {
	*ListPendingInvitationResourcesOutput
	// contains filtered or unexported fields
}

ListPendingInvitationResourcesResponse is the response type for the ListPendingInvitationResources API operation.

func (*ListPendingInvitationResourcesResponse) SDKResponseMetdata added in v0.13.0

func (r *ListPendingInvitationResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPendingInvitationResources request.

type ListPermissionsInput added in v0.18.0

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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"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 `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

func (ListPermissionsInput) MarshalFields added in v0.18.0

func (s ListPermissionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPermissionsInput) String added in v0.18.0

func (s ListPermissionsInput) String() string

String returns the string representation

func (*ListPermissionsInput) Validate added in v0.18.0

func (s *ListPermissionsInput) Validate() error

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

type ListPermissionsOutput added in v0.18.0

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 `locationName:"nextToken" type:"string"`

	// Information about the permissions.
	Permissions []ResourceSharePermissionSummary `locationName:"permissions" type:"list"`
	// contains filtered or unexported fields
}

func (ListPermissionsOutput) MarshalFields added in v0.18.0

func (s ListPermissionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPermissionsOutput) String added in v0.18.0

func (s ListPermissionsOutput) String() string

String returns the string representation

type ListPermissionsRequest added in v0.18.0

type ListPermissionsRequest struct {
	*aws.Request
	Input *ListPermissionsInput
	Copy  func(*ListPermissionsInput) ListPermissionsRequest
}

ListPermissionsRequest is the request type for the ListPermissions API operation.

func (ListPermissionsRequest) Send added in v0.18.0

Send marshals and sends the ListPermissions API request.

type ListPermissionsResponse added in v0.18.0

type ListPermissionsResponse struct {
	*ListPermissionsOutput
	// contains filtered or unexported fields
}

ListPermissionsResponse is the response type for the ListPermissions API operation.

func (*ListPermissionsResponse) SDKResponseMetdata added in v0.18.0

func (r *ListPermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPermissions request.

type ListPrincipalsInput

type ListPrincipalsInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The principals.
	Principals []string `locationName:"principals" type:"list"`

	// The Amazon Resource Name (ARN) of the resource.
	ResourceArn *string `locationName:"resourceArn" type:"string"`

	// The type of owner.
	//
	// ResourceOwner is a required field
	ResourceOwner ResourceOwner `locationName:"resourceOwner" type:"string" required:"true" enum:"true"`

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string `locationName:"resourceShareArns" type:"list"`

	// The resource type.
	//
	// Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation
	// | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway
	// | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe
	// | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster
	// | route53resolver:ResolverRule
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

func (ListPrincipalsInput) MarshalFields

func (s ListPrincipalsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPrincipalsInput) String

func (s ListPrincipalsInput) String() string

String returns the string representation

func (*ListPrincipalsInput) Validate

func (s *ListPrincipalsInput) Validate() error

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

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 `locationName:"nextToken" type:"string"`

	// The principals.
	Principals []Principal `locationName:"principals" type:"list"`
	// contains filtered or unexported fields
}

func (ListPrincipalsOutput) MarshalFields

func (s ListPrincipalsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPrincipalsOutput) String

func (s ListPrincipalsOutput) String() string

String returns the string representation

type ListPrincipalsPaginator added in v0.9.0

type ListPrincipalsPaginator struct {
	aws.Pager
}

ListPrincipalsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPrincipalsPaginator added in v0.9.0

func NewListPrincipalsPaginator(req ListPrincipalsRequest) ListPrincipalsPaginator

NewListPrincipalsRequestPaginator returns a paginator for ListPrincipals. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListPrincipalsRequest(input)
p := ram.NewListPrincipalsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPrincipalsPaginator) CurrentPage added in v0.9.0

type ListPrincipalsRequest

type ListPrincipalsRequest struct {
	*aws.Request
	Input *ListPrincipalsInput
	Copy  func(*ListPrincipalsInput) ListPrincipalsRequest
}

ListPrincipalsRequest is the request type for the ListPrincipals API operation.

func (ListPrincipalsRequest) Send

Send marshals and sends the ListPrincipals API request.

type ListPrincipalsResponse added in v0.9.0

type ListPrincipalsResponse struct {
	*ListPrincipalsOutput
	// contains filtered or unexported fields
}

ListPrincipalsResponse is the response type for the ListPrincipals API operation.

func (*ListPrincipalsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListPrincipalsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPrincipals request.

type ListResourceSharePermissionsInput added in v0.18.0

type ListResourceSharePermissionsInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListResourceSharePermissionsInput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourceSharePermissionsInput) String added in v0.18.0

String returns the string representation

func (*ListResourceSharePermissionsInput) Validate added in v0.18.0

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

type ListResourceSharePermissionsOutput added in v0.18.0

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 `locationName:"nextToken" type:"string"`

	// The permissions associated with the resource share.
	Permissions []ResourceSharePermissionSummary `locationName:"permissions" type:"list"`
	// contains filtered or unexported fields
}

func (ListResourceSharePermissionsOutput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourceSharePermissionsOutput) String added in v0.18.0

String returns the string representation

type ListResourceSharePermissionsRequest added in v0.18.0

type ListResourceSharePermissionsRequest struct {
	*aws.Request
	Input *ListResourceSharePermissionsInput
	Copy  func(*ListResourceSharePermissionsInput) ListResourceSharePermissionsRequest
}

ListResourceSharePermissionsRequest is the request type for the ListResourceSharePermissions API operation.

func (ListResourceSharePermissionsRequest) Send added in v0.18.0

Send marshals and sends the ListResourceSharePermissions API request.

type ListResourceSharePermissionsResponse added in v0.18.0

type ListResourceSharePermissionsResponse struct {
	*ListResourceSharePermissionsOutput
	// contains filtered or unexported fields
}

ListResourceSharePermissionsResponse is the response type for the ListResourceSharePermissions API operation.

func (*ListResourceSharePermissionsResponse) SDKResponseMetdata added in v0.18.0

func (r *ListResourceSharePermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListResourceSharePermissions request.

type ListResourceTypesInput added in v0.22.0

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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListResourceTypesInput) MarshalFields added in v0.22.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourceTypesInput) String added in v0.22.0

func (s ListResourceTypesInput) String() string

String returns the string representation

func (*ListResourceTypesInput) Validate added in v0.22.0

func (s *ListResourceTypesInput) Validate() error

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

type ListResourceTypesOutput added in v0.22.0

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 `locationName:"nextToken" type:"string"`

	// The shareable resource types supported by AWS RAM.
	ResourceTypes []ServiceNameAndResourceType `locationName:"resourceTypes" type:"list"`
	// contains filtered or unexported fields
}

func (ListResourceTypesOutput) MarshalFields added in v0.22.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourceTypesOutput) String added in v0.22.0

func (s ListResourceTypesOutput) String() string

String returns the string representation

type ListResourceTypesRequest added in v0.22.0

type ListResourceTypesRequest struct {
	*aws.Request
	Input *ListResourceTypesInput
	Copy  func(*ListResourceTypesInput) ListResourceTypesRequest
}

ListResourceTypesRequest is the request type for the ListResourceTypes API operation.

func (ListResourceTypesRequest) Send added in v0.22.0

Send marshals and sends the ListResourceTypes API request.

type ListResourceTypesResponse added in v0.22.0

type ListResourceTypesResponse struct {
	*ListResourceTypesOutput
	// contains filtered or unexported fields
}

ListResourceTypesResponse is the response type for the ListResourceTypes API operation.

func (*ListResourceTypesResponse) SDKResponseMetdata added in v0.22.0

func (r *ListResourceTypesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListResourceTypes request.

type ListResourcesInput

type ListResourcesInput 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The principal.
	Principal *string `locationName:"principal" type:"string"`

	// The Amazon Resource Names (ARN) of the resources.
	ResourceArns []string `locationName:"resourceArns" type:"list"`

	// The type of owner.
	//
	// ResourceOwner is a required field
	ResourceOwner ResourceOwner `locationName:"resourceOwner" type:"string" required:"true" enum:"true"`

	// The Amazon Resource Names (ARN) of the resource shares.
	ResourceShareArns []string `locationName:"resourceShareArns" type:"list"`

	// The resource type.
	//
	// Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation
	// | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway
	// | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe
	// | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster
	// | route53resolver:ResolverRule
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

func (ListResourcesInput) MarshalFields

func (s ListResourcesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourcesInput) String

func (s ListResourcesInput) String() string

String returns the string representation

func (*ListResourcesInput) Validate

func (s *ListResourcesInput) Validate() error

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

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 `locationName:"nextToken" type:"string"`

	// Information about the resources.
	Resources []Resource `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

func (ListResourcesOutput) MarshalFields

func (s ListResourcesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListResourcesOutput) String

func (s ListResourcesOutput) String() string

String returns the string representation

type ListResourcesPaginator added in v0.9.0

type ListResourcesPaginator struct {
	aws.Pager
}

ListResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListResourcesPaginator added in v0.9.0

func NewListResourcesPaginator(req ListResourcesRequest) ListResourcesPaginator

NewListResourcesRequestPaginator returns a paginator for ListResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListResourcesRequest(input)
p := ram.NewListResourcesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListResourcesPaginator) CurrentPage added in v0.9.0

func (p *ListResourcesPaginator) CurrentPage() *ListResourcesOutput

type ListResourcesRequest

type ListResourcesRequest struct {
	*aws.Request
	Input *ListResourcesInput
	Copy  func(*ListResourcesInput) ListResourcesRequest
}

ListResourcesRequest is the request type for the ListResources API operation.

func (ListResourcesRequest) Send

Send marshals and sends the ListResources API request.

type ListResourcesResponse added in v0.9.0

type ListResourcesResponse struct {
	*ListResourcesOutput
	// contains filtered or unexported fields
}

ListResourcesResponse is the response type for the ListResources API operation.

func (*ListResourcesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListResources request.

type Principal

type Principal struct {

	// The time when the principal was associated with the resource share.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// Indicates whether the principal belongs to the same AWS organization as the
	// AWS account that owns the resource share.
	External *bool `locationName:"external" type:"boolean"`

	// The ID of the principal.
	Id *string `locationName:"id" type:"string"`

	// The time when the association was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string"`
	// contains filtered or unexported fields
}

Describes a principal for use with AWS Resource Access Manager.

func (Principal) MarshalFields

func (s Principal) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Principal) String

func (s Principal) String() string

String returns the string representation

type PromoteResourceShareCreatedFromPolicyInput added in v0.18.0

type PromoteResourceShareCreatedFromPolicyInput struct {

	// The ARN of the resource share to promote.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `location:"querystring" locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PromoteResourceShareCreatedFromPolicyInput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PromoteResourceShareCreatedFromPolicyInput) String added in v0.18.0

String returns the string representation

func (*PromoteResourceShareCreatedFromPolicyInput) Validate added in v0.18.0

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

type PromoteResourceShareCreatedFromPolicyOutput added in v0.18.0

type PromoteResourceShareCreatedFromPolicyOutput struct {

	// Indicates whether the request succeeded.
	ReturnValue *bool `locationName:"returnValue" type:"boolean"`
	// contains filtered or unexported fields
}

func (PromoteResourceShareCreatedFromPolicyOutput) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PromoteResourceShareCreatedFromPolicyOutput) String added in v0.18.0

String returns the string representation

type PromoteResourceShareCreatedFromPolicyRequest added in v0.18.0

PromoteResourceShareCreatedFromPolicyRequest is the request type for the PromoteResourceShareCreatedFromPolicy API operation.

func (PromoteResourceShareCreatedFromPolicyRequest) Send added in v0.18.0

Send marshals and sends the PromoteResourceShareCreatedFromPolicy API request.

type PromoteResourceShareCreatedFromPolicyResponse added in v0.18.0

type PromoteResourceShareCreatedFromPolicyResponse struct {
	*PromoteResourceShareCreatedFromPolicyOutput
	// contains filtered or unexported fields
}

PromoteResourceShareCreatedFromPolicyResponse is the response type for the PromoteResourceShareCreatedFromPolicy API operation.

func (*PromoteResourceShareCreatedFromPolicyResponse) SDKResponseMetdata added in v0.18.0

SDKResponseMetdata returns the response metadata for the PromoteResourceShareCreatedFromPolicy request.

type RejectResourceShareInvitationInput

type RejectResourceShareInvitationInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The Amazon Resource Name (ARN) of the invitation.
	//
	// ResourceShareInvitationArn is a required field
	ResourceShareInvitationArn *string `locationName:"resourceShareInvitationArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RejectResourceShareInvitationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RejectResourceShareInvitationInput) String

String returns the string representation

func (*RejectResourceShareInvitationInput) Validate

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

type RejectResourceShareInvitationOutput

type RejectResourceShareInvitationOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the invitation.
	ResourceShareInvitation *ResourceShareInvitation `locationName:"resourceShareInvitation" type:"structure"`
	// contains filtered or unexported fields
}

func (RejectResourceShareInvitationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RejectResourceShareInvitationOutput) String

String returns the string representation

type RejectResourceShareInvitationRequest

type RejectResourceShareInvitationRequest struct {
	*aws.Request
	Input *RejectResourceShareInvitationInput
	Copy  func(*RejectResourceShareInvitationInput) RejectResourceShareInvitationRequest
}

RejectResourceShareInvitationRequest is the request type for the RejectResourceShareInvitation API operation.

func (RejectResourceShareInvitationRequest) Send

Send marshals and sends the RejectResourceShareInvitation API request.

type RejectResourceShareInvitationResponse added in v0.9.0

type RejectResourceShareInvitationResponse struct {
	*RejectResourceShareInvitationOutput
	// contains filtered or unexported fields
}

RejectResourceShareInvitationResponse is the response type for the RejectResourceShareInvitation API operation.

func (*RejectResourceShareInvitationResponse) SDKResponseMetdata added in v0.9.0

func (r *RejectResourceShareInvitationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RejectResourceShareInvitation request.

type Resource

type Resource struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string `locationName:"arn" type:"string"`

	// The time when the resource was associated with the resource share.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The time when the association was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The ARN of the resource group. This value is returned only if the resource
	// is a resource group.
	ResourceGroupArn *string `locationName:"resourceGroupArn" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string"`

	// The status of the resource.
	Status ResourceStatus `locationName:"status" type:"string" enum:"true"`

	// A message about the status of the resource.
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// The resource type.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Describes a resource associated with a resource share.

func (Resource) MarshalFields

func (s Resource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Resource) String

func (s Resource) String() string

String returns the string representation

type ResourceOwner

type ResourceOwner string
const (
	ResourceOwnerSelf          ResourceOwner = "SELF"
	ResourceOwnerOtherAccounts ResourceOwner = "OTHER-ACCOUNTS"
)

Enum values for ResourceOwner

func (ResourceOwner) MarshalValue

func (enum ResourceOwner) MarshalValue() (string, error)

func (ResourceOwner) MarshalValueBuf

func (enum ResourceOwner) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceShare

type ResourceShare struct {

	// Indicates whether principals outside your AWS organization can be associated
	// with a resource share.
	AllowExternalPrincipals *bool `locationName:"allowExternalPrincipals" type:"boolean"`

	// The time when the resource share was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// Indicates how the resource share was created. Possible values include:
	//
	//    * CREATED_FROM_POLICY - Indicates that the resource share was created
	//    from an AWS Identity and Access Management (AWS IAM) policy attached to
	//    a resource. These resource shares are visible only to the AWS account
	//    that created it. They cannot be modified in AWS RAM.
	//
	//    * PROMOTING_TO_STANDARD - The resource share is in the process of being
	//    promoted. For more information, see PromoteResourceShareCreatedFromPolicy.
	//
	//    * STANDARD - Indicates that the resource share was created in AWS RAM
	//    using the console or APIs. These resource shares are visible to all principals.
	//    They can be modified in AWS RAM.
	FeatureSet ResourceShareFeatureSet `locationName:"featureSet" type:"string" enum:"true"`

	// The time when the resource share was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The name of the resource share.
	Name *string `locationName:"name" type:"string"`

	// The ID of the AWS account that owns the resource share.
	OwningAccountId *string `locationName:"owningAccountId" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string"`

	// The status of the resource share.
	Status ResourceShareStatus `locationName:"status" type:"string" enum:"true"`

	// A message about the status of the resource share.
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// The tags for the resource share.
	Tags []Tag `locationName:"tags" type:"list"`
	// contains filtered or unexported fields
}

Describes a resource share.

func (ResourceShare) MarshalFields

func (s ResourceShare) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceShare) String

func (s ResourceShare) String() string

String returns the string representation

type ResourceShareAssociation

type ResourceShareAssociation struct {

	// The associated entity. For resource associations, this is the ARN of the
	// resource. For principal associations, this is the ID of an AWS account or
	// the ARN of an OU or organization from AWS Organizations.
	AssociatedEntity *string `locationName:"associatedEntity" type:"string"`

	// The association type.
	AssociationType ResourceShareAssociationType `locationName:"associationType" type:"string" enum:"true"`

	// The time when the association was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// Indicates whether the principal belongs to the same AWS organization as the
	// AWS account that owns the resource share.
	External *bool `locationName:"external" type:"boolean"`

	// The time when the association was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string"`

	// The name of the resource share.
	ResourceShareName *string `locationName:"resourceShareName" type:"string"`

	// The status of the association.
	Status ResourceShareAssociationStatus `locationName:"status" type:"string" enum:"true"`

	// A message about the status of the association.
	StatusMessage *string `locationName:"statusMessage" type:"string"`
	// contains filtered or unexported fields
}

Describes an association with a resource share.

func (ResourceShareAssociation) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceShareAssociation) String

func (s ResourceShareAssociation) String() string

String returns the string representation

type ResourceShareAssociationStatus

type ResourceShareAssociationStatus string
const (
	ResourceShareAssociationStatusAssociating    ResourceShareAssociationStatus = "ASSOCIATING"
	ResourceShareAssociationStatusAssociated     ResourceShareAssociationStatus = "ASSOCIATED"
	ResourceShareAssociationStatusFailed         ResourceShareAssociationStatus = "FAILED"
	ResourceShareAssociationStatusDisassociating ResourceShareAssociationStatus = "DISASSOCIATING"
	ResourceShareAssociationStatusDisassociated  ResourceShareAssociationStatus = "DISASSOCIATED"
)

Enum values for ResourceShareAssociationStatus

func (ResourceShareAssociationStatus) MarshalValue

func (enum ResourceShareAssociationStatus) MarshalValue() (string, error)

func (ResourceShareAssociationStatus) MarshalValueBuf

func (enum ResourceShareAssociationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceShareAssociationType

type ResourceShareAssociationType string
const (
	ResourceShareAssociationTypePrincipal ResourceShareAssociationType = "PRINCIPAL"
	ResourceShareAssociationTypeResource  ResourceShareAssociationType = "RESOURCE"
)

Enum values for ResourceShareAssociationType

func (ResourceShareAssociationType) MarshalValue

func (enum ResourceShareAssociationType) MarshalValue() (string, error)

func (ResourceShareAssociationType) MarshalValueBuf

func (enum ResourceShareAssociationType) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceShareFeatureSet added in v0.18.0

type ResourceShareFeatureSet string
const (
	ResourceShareFeatureSetCreatedFromPolicy   ResourceShareFeatureSet = "CREATED_FROM_POLICY"
	ResourceShareFeatureSetPromotingToStandard ResourceShareFeatureSet = "PROMOTING_TO_STANDARD"
	ResourceShareFeatureSetStandard            ResourceShareFeatureSet = "STANDARD"
)

Enum values for ResourceShareFeatureSet

func (ResourceShareFeatureSet) MarshalValue added in v0.18.0

func (enum ResourceShareFeatureSet) MarshalValue() (string, error)

func (ResourceShareFeatureSet) MarshalValueBuf added in v0.18.0

func (enum ResourceShareFeatureSet) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceShareInvitation

type ResourceShareInvitation struct {

	// The date and time when the invitation was sent.
	InvitationTimestamp *time.Time `locationName:"invitationTimestamp" type:"timestamp"`

	// The ID of the AWS account that received the invitation.
	ReceiverAccountId *string `locationName:"receiverAccountId" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string"`

	// To view the resources associated with a pending resource share invitation,
	// use ListPendingInvitationResources (https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html).
	ResourceShareAssociations []ResourceShareAssociation `locationName:"resourceShareAssociations" deprecated:"true" type:"list"`

	// The Amazon Resource Name (ARN) of the invitation.
	ResourceShareInvitationArn *string `locationName:"resourceShareInvitationArn" type:"string"`

	// The name of the resource share.
	ResourceShareName *string `locationName:"resourceShareName" type:"string"`

	// The ID of the AWS account that sent the invitation.
	SenderAccountId *string `locationName:"senderAccountId" type:"string"`

	// The status of the invitation.
	Status ResourceShareInvitationStatus `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes an invitation to join a resource share.

func (ResourceShareInvitation) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceShareInvitation) String

func (s ResourceShareInvitation) String() string

String returns the string representation

type ResourceShareInvitationStatus

type ResourceShareInvitationStatus string
const (
	ResourceShareInvitationStatusPending  ResourceShareInvitationStatus = "PENDING"
	ResourceShareInvitationStatusAccepted ResourceShareInvitationStatus = "ACCEPTED"
	ResourceShareInvitationStatusRejected ResourceShareInvitationStatus = "REJECTED"
	ResourceShareInvitationStatusExpired  ResourceShareInvitationStatus = "EXPIRED"
)

Enum values for ResourceShareInvitationStatus

func (ResourceShareInvitationStatus) MarshalValue

func (enum ResourceShareInvitationStatus) MarshalValue() (string, error)

func (ResourceShareInvitationStatus) MarshalValueBuf

func (enum ResourceShareInvitationStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceSharePermissionDetail added in v0.18.0

type ResourceSharePermissionDetail struct {

	// The ARN of the permission.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time when the permission was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The identifier for the version of the permission that is set as the default
	// version.
	DefaultVersion *bool `locationName:"defaultVersion" type:"boolean"`

	// The date and time when the permission was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The name of the permission.
	Name *string `locationName:"name" type:"string"`

	// The permission's effect and actions in JSON format. The effect indicates
	// whether the actions are allowed or denied. The actions list the API actions
	// to which the principal is granted or denied access.
	Permission *string `locationName:"permission" type:"string"`

	// The resource type to which the permission applies.
	ResourceType *string `locationName:"resourceType" type:"string"`

	// The identifier for the version of the permission.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

Information about an AWS RAM permission.

func (ResourceSharePermissionDetail) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceSharePermissionDetail) String added in v0.18.0

String returns the string representation

type ResourceSharePermissionSummary added in v0.18.0

type ResourceSharePermissionSummary struct {

	// The ARN of the permission.
	Arn *string `locationName:"arn" type:"string"`

	// The date and time when the permission was created.
	CreationTime *time.Time `locationName:"creationTime" type:"timestamp"`

	// The identifier for the version of the permission that is set as the default
	// version.
	DefaultVersion *bool `locationName:"defaultVersion" type:"boolean"`

	// The date and time when the permission was last updated.
	LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"`

	// The name of the permission.
	Name *string `locationName:"name" type:"string"`

	// The type of resource to which the permission applies.
	ResourceType *string `locationName:"resourceType" type:"string"`

	// The current status of the permission.
	Status *string `locationName:"status" type:"string"`

	// The identifier for the version of the permission.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

Information about a permission that is associated with a resource share.

func (ResourceSharePermissionSummary) MarshalFields added in v0.18.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceSharePermissionSummary) String added in v0.18.0

String returns the string representation

type ResourceShareStatus

type ResourceShareStatus string
const (
	ResourceShareStatusPending  ResourceShareStatus = "PENDING"
	ResourceShareStatusActive   ResourceShareStatus = "ACTIVE"
	ResourceShareStatusFailed   ResourceShareStatus = "FAILED"
	ResourceShareStatusDeleting ResourceShareStatus = "DELETING"
	ResourceShareStatusDeleted  ResourceShareStatus = "DELETED"
)

Enum values for ResourceShareStatus

func (ResourceShareStatus) MarshalValue

func (enum ResourceShareStatus) MarshalValue() (string, error)

func (ResourceShareStatus) MarshalValueBuf

func (enum ResourceShareStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ResourceStatus

type ResourceStatus string
const (
	ResourceStatusAvailable                 ResourceStatus = "AVAILABLE"
	ResourceStatusZonalResourceInaccessible ResourceStatus = "ZONAL_RESOURCE_INACCESSIBLE"
	ResourceStatusLimitExceeded             ResourceStatus = "LIMIT_EXCEEDED"
	ResourceStatusUnavailable               ResourceStatus = "UNAVAILABLE"
	ResourceStatusPending                   ResourceStatus = "PENDING"
)

Enum values for ResourceStatus

func (ResourceStatus) MarshalValue

func (enum ResourceStatus) MarshalValue() (string, error)

func (ResourceStatus) MarshalValueBuf

func (enum ResourceStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ServiceNameAndResourceType added in v0.22.0

type ServiceNameAndResourceType struct {

	// The shareable resource types.
	ResourceType *string `locationName:"resourceType" type:"string"`

	// The name of the AWS services to which the resources belong.
	ServiceName *string `locationName:"serviceName" type:"string"`
	// contains filtered or unexported fields
}

Information about the shareable resource types and the AWS services to which they belong.

func (ServiceNameAndResourceType) MarshalFields added in v0.22.0

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ServiceNameAndResourceType) String added in v0.22.0

String returns the string representation

type Tag

type Tag struct {

	// The key of the tag.
	Key *string `locationName:"key" type:"string"`

	// The value of the tag.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

Information about a tag.

func (Tag) MarshalFields

func (s Tag) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Tag) String

func (s Tag) String() string

String returns the string representation

type TagFilter

type TagFilter struct {

	// The tag key.
	TagKey *string `locationName:"tagKey" type:"string"`

	// The tag values.
	TagValues []string `locationName:"tagValues" type:"list"`
	// contains filtered or unexported fields
}

Used to filter information based on tags.

func (TagFilter) MarshalFields

func (s TagFilter) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagFilter) String

func (s TagFilter) String() string

String returns the string representation

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`

	// One or more tags.
	//
	// Tags is a required field
	Tags []Tag `locationName:"tags" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) MarshalFields

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`

	// The tag keys of the tags to remove.
	//
	// TagKeys is a required field
	TagKeys []string `locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) MarshalFields

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateResourceShareInput

type UpdateResourceShareInput struct {

	// Indicates whether principals outside your AWS organization can be associated
	// with a resource share.
	AllowExternalPrincipals *bool `locationName:"allowExternalPrincipals" type:"boolean"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// The name of the resource share.
	Name *string `locationName:"name" type:"string"`

	// The Amazon Resource Name (ARN) of the resource share.
	//
	// ResourceShareArn is a required field
	ResourceShareArn *string `locationName:"resourceShareArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateResourceShareInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateResourceShareInput) String

func (s UpdateResourceShareInput) String() string

String returns the string representation

func (*UpdateResourceShareInput) Validate

func (s *UpdateResourceShareInput) Validate() error

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

type UpdateResourceShareOutput

type UpdateResourceShareOutput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string"`

	// Information about the resource share.
	ResourceShare *ResourceShare `locationName:"resourceShare" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateResourceShareOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateResourceShareOutput) String

func (s UpdateResourceShareOutput) String() string

String returns the string representation

type UpdateResourceShareRequest

type UpdateResourceShareRequest struct {
	*aws.Request
	Input *UpdateResourceShareInput
	Copy  func(*UpdateResourceShareInput) UpdateResourceShareRequest
}

UpdateResourceShareRequest is the request type for the UpdateResourceShare API operation.

func (UpdateResourceShareRequest) Send

Send marshals and sends the UpdateResourceShare API request.

type UpdateResourceShareResponse added in v0.9.0

type UpdateResourceShareResponse struct {
	*UpdateResourceShareOutput
	// contains filtered or unexported fields
}

UpdateResourceShareResponse is the response type for the UpdateResourceShare API operation.

func (*UpdateResourceShareResponse) SDKResponseMetdata added in v0.9.0

func (r *UpdateResourceShareResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateResourceShare request.

Directories

Path Synopsis
Package ramiface provides an interface to enable mocking the AWS Resource Access Manager service client for testing your code.
Package ramiface provides an interface to enable mocking the AWS Resource Access Manager service client for testing your code.

Jump to

Keyboard shortcuts

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