Documentation ¶
Overview ¶
Package ram provides the API client, operations, and parameter types for AWS Resource Access Manager.
This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If you use Organizations to manage your accounts, then you can share your resources with your entire organization or to organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles and users.
To learn more about RAM, see the following resources:
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AcceptResourceShareInvitationInput
- type AcceptResourceShareInvitationOutput
- type AssociateResourceShareInput
- type AssociateResourceShareOutput
- type AssociateResourceSharePermissionInput
- type AssociateResourceSharePermissionOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, ...) (*AcceptResourceShareInvitationOutput, error)
- func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, ...) (*AssociateResourceShareOutput, error)
- func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, ...) (*AssociateResourceSharePermissionOutput, error)
- func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionInput, optFns ...func(*Options)) (*CreatePermissionOutput, error)
- func (c *Client) CreatePermissionVersion(ctx context.Context, params *CreatePermissionVersionInput, ...) (*CreatePermissionVersionOutput, error)
- func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, ...) (*CreateResourceShareOutput, error)
- func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionInput, optFns ...func(*Options)) (*DeletePermissionOutput, error)
- func (c *Client) DeletePermissionVersion(ctx context.Context, params *DeletePermissionVersionInput, ...) (*DeletePermissionVersionOutput, error)
- func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, ...) (*DeleteResourceShareOutput, error)
- func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, ...) (*DisassociateResourceShareOutput, error)
- func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, ...) (*DisassociateResourceSharePermissionOutput, error)
- func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, ...) (*EnableSharingWithAwsOrganizationOutput, error)
- func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error)
- func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, ...) (*GetResourcePoliciesOutput, error)
- func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, ...) (*GetResourceShareAssociationsOutput, error)
- func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, ...) (*GetResourceShareInvitationsOutput, error)
- func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
- func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, ...) (*ListPendingInvitationResourcesOutput, error)
- func (c *Client) ListPermissionAssociations(ctx context.Context, params *ListPermissionAssociationsInput, ...) (*ListPermissionAssociationsOutput, error)
- func (c *Client) ListPermissionVersions(ctx context.Context, params *ListPermissionVersionsInput, ...) (*ListPermissionVersionsOutput, error)
- func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)
- func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
- func (c *Client) ListReplacePermissionAssociationsWork(ctx context.Context, params *ListReplacePermissionAssociationsWorkInput, ...) (*ListReplacePermissionAssociationsWorkOutput, error)
- func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, ...) (*ListResourceSharePermissionsOutput, error)
- func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
- func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PromotePermissionCreatedFromPolicy(ctx context.Context, params *PromotePermissionCreatedFromPolicyInput, ...) (*PromotePermissionCreatedFromPolicyOutput, error)
- func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, ...) (*PromoteResourceShareCreatedFromPolicyOutput, error)
- func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, ...) (*RejectResourceShareInvitationOutput, error)
- func (c *Client) ReplacePermissionAssociations(ctx context.Context, params *ReplacePermissionAssociationsInput, ...) (*ReplacePermissionAssociationsOutput, error)
- func (c *Client) SetDefaultPermissionVersion(ctx context.Context, params *SetDefaultPermissionVersionInput, ...) (*SetDefaultPermissionVersionOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResourceShareInput, ...) (*UpdateResourceShareOutput, error)
- type CreatePermissionInput
- type CreatePermissionOutput
- type CreatePermissionVersionInput
- type CreatePermissionVersionOutput
- type CreateResourceShareInput
- type CreateResourceShareOutput
- type DeletePermissionInput
- type DeletePermissionOutput
- type DeletePermissionVersionInput
- type DeletePermissionVersionOutput
- type DeleteResourceShareInput
- type DeleteResourceShareOutput
- type DisassociateResourceShareInput
- type DisassociateResourceShareOutput
- type DisassociateResourceSharePermissionInput
- type DisassociateResourceSharePermissionOutput
- type EnableSharingWithAwsOrganizationInput
- type EnableSharingWithAwsOrganizationOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetPermissionInput
- type GetPermissionOutput
- type GetResourcePoliciesAPIClient
- type GetResourcePoliciesInput
- type GetResourcePoliciesOutput
- type GetResourcePoliciesPaginator
- type GetResourcePoliciesPaginatorOptions
- type GetResourceShareAssociationsAPIClient
- type GetResourceShareAssociationsInput
- type GetResourceShareAssociationsOutput
- type GetResourceShareAssociationsPaginator
- type GetResourceShareAssociationsPaginatorOptions
- type GetResourceShareInvitationsAPIClient
- type GetResourceShareInvitationsInput
- type GetResourceShareInvitationsOutput
- type GetResourceShareInvitationsPaginator
- type GetResourceShareInvitationsPaginatorOptions
- type GetResourceSharesAPIClient
- type GetResourceSharesInput
- type GetResourceSharesOutput
- type GetResourceSharesPaginator
- type GetResourceSharesPaginatorOptions
- type HTTPClient
- type HTTPSignerV4
- type ListPendingInvitationResourcesAPIClient
- type ListPendingInvitationResourcesInput
- type ListPendingInvitationResourcesOutput
- type ListPendingInvitationResourcesPaginator
- type ListPendingInvitationResourcesPaginatorOptions
- type ListPermissionAssociationsAPIClient
- type ListPermissionAssociationsInput
- type ListPermissionAssociationsOutput
- type ListPermissionAssociationsPaginator
- type ListPermissionAssociationsPaginatorOptions
- type ListPermissionVersionsAPIClient
- type ListPermissionVersionsInput
- type ListPermissionVersionsOutput
- type ListPermissionVersionsPaginator
- type ListPermissionVersionsPaginatorOptions
- type ListPermissionsAPIClient
- type ListPermissionsInput
- type ListPermissionsOutput
- type ListPermissionsPaginator
- type ListPermissionsPaginatorOptions
- type ListPrincipalsAPIClient
- type ListPrincipalsInput
- type ListPrincipalsOutput
- type ListPrincipalsPaginator
- type ListPrincipalsPaginatorOptions
- type ListReplacePermissionAssociationsWorkAPIClient
- type ListReplacePermissionAssociationsWorkInput
- type ListReplacePermissionAssociationsWorkOutput
- type ListReplacePermissionAssociationsWorkPaginator
- type ListReplacePermissionAssociationsWorkPaginatorOptions
- type ListResourceSharePermissionsAPIClient
- type ListResourceSharePermissionsInput
- type ListResourceSharePermissionsOutput
- type ListResourceSharePermissionsPaginator
- type ListResourceSharePermissionsPaginatorOptions
- type ListResourceTypesAPIClient
- type ListResourceTypesInput
- type ListResourceTypesOutput
- type ListResourceTypesPaginator
- type ListResourceTypesPaginatorOptions
- type ListResourcesAPIClient
- type ListResourcesInput
- type ListResourcesOutput
- type ListResourcesPaginator
- type ListResourcesPaginatorOptions
- type Options
- type PromotePermissionCreatedFromPolicyInput
- type PromotePermissionCreatedFromPolicyOutput
- type PromoteResourceShareCreatedFromPolicyInput
- type PromoteResourceShareCreatedFromPolicyOutput
- type RejectResourceShareInvitationInput
- type RejectResourceShareInvitationOutput
- type ReplacePermissionAssociationsInput
- type ReplacePermissionAssociationsOutput
- type ResolveEndpoint
- type SetDefaultPermissionVersionInput
- type SetDefaultPermissionVersionOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateResourceShareInput
- type UpdateResourceShareOutput
Constants ¶
const ServiceAPIVersion = "2018-01-04"
const ServiceID = "RAM"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AcceptResourceShareInvitationInput ¶
type AcceptResourceShareInvitationInput struct { // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type AcceptResourceShareInvitationOutput ¶
type AcceptResourceShareInvitationOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string ResourceShareInvitation *types.ResourceShareInvitation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateResourceShareInput ¶
type AssociateResourceShareInput struct { // resources to. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // be null if you want to add only resources. // // What the principals can do with the resources in the share is determined by the // RAM permissions that you associate with the resource share. See AssociateResourceSharePermission. // // You can include the following values: // // - An Amazon Web Services account ID, for example: 123456789012 // // - An [Amazon Resource Name (ARN)]of an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // - An ARN of an organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // - An ARN of an IAM role, for example: iam::123456789012:role/rolename // // - An ARN of an IAM user, for example: iam::123456789012user/username // // Not all resource types can be shared with IAM roles and users. For more // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // if you want to add only principals. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // resources in this resource share. Sources []string // contains filtered or unexported fields }
type AssociateResourceShareOutput ¶
type AssociateResourceShareOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string ResourceShareAssociations []types.ResourceShareAssociation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateResourceSharePermissionInput ¶
type AssociateResourceSharePermissionInput struct { // find the ARN for a permission, use either the ListPermissionsoperation or go to the [Permissions library] page in // the RAM console and then choose the name of the permission. The ARN is displayed // on the detail page. // // [Permissions library]: https://console.aws.amazon.com/ram/home#Permissions: // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // permissions. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // share. You can specify only the version that is currently set as the default // version for the permission. If you also set the replace pararameter to true , // then this operation updates an outdated version of the permission to the current // default version. // // You don't need to specify this parameter because the default behavior is to use // the version that is currently set as the default version for the permission. // This parameter is supported for backwards compatibility. PermissionVersion *int32 // permission associated with the resource share. Use true to replace the current // permissions. Use false to add the permission to a resource share that currently // doesn't have a permission. The default value is false . // // A resource share can have only one permission per resource type. If a resource // share already has a permission for the specified resource type and you don't set // replace to true then the operation returns an error. This helps prevent // accidental overwriting of a permission. Replace *bool // contains filtered or unexported fields }
type AssociateResourceSharePermissionOutput ¶
type AssociateResourceSharePermissionOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // indicates that the request failed. ReturnValue *bool ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Resource Access Manager.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AcceptResourceShareInvitation ¶
func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, optFns ...func(*Options)) (*AcceptResourceShareInvitationOutput, error)
Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.
func (*Client) AssociateResourceShare ¶
func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error)
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
func (*Client) AssociateResourceSharePermission ¶
func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, optFns ...func(*Options)) (*AssociateResourceSharePermissionOutput, error)
Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.
func (*Client) CreatePermission ¶
func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionInput, optFns ...func(*Options)) (*CreatePermissionOutput, error)
Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.
func (*Client) CreatePermissionVersion ¶
func (c *Client) CreatePermissionVersion(ctx context.Context, params *CreatePermissionVersionInput, optFns ...func(*Options)) (*CreatePermissionVersionOutput, error)
Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociationsto update them.
If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.
func (*Client) CreateResourceShare ¶
func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error)
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.
Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
func (*Client) DeletePermission ¶
func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionInput, optFns ...func(*Options)) (*DeletePermissionOutput, error)
Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.
func (*Client) DeletePermissionVersion ¶
func (c *Client) DeletePermissionVersion(ctx context.Context, params *DeletePermissionVersionInput, optFns ...func(*Options)) (*DeletePermissionVersionOutput, error)
Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.
If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.
func (*Client) DeleteResourceShare ¶
func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error)
Deletes the specified resource share.
This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.
func (*Client) DisassociateResourceShare ¶
func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, optFns ...func(*Options)) (*DisassociateResourceShareOutput, error)
Removes the specified principals or resources from participating in the specified resource share.
func (*Client) DisassociateResourceSharePermission ¶
func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, optFns ...func(*Options)) (*DisassociateResourceSharePermissionOutput, error)
Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
func (*Client) EnableSharingWithAwsOrganization ¶
func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error)
Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.
You must call this operation from an IAM role or user in the organization's management account.
func (*Client) GetPermission ¶
func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error)
Retrieves the contents of a managed permission in JSON format.
func (*Client) GetResourcePolicies ¶
func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
Retrieves the resource policies for the specified resources that you own and have shared.
func (*Client) GetResourceShareAssociations ¶
func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
Retrieves the lists of resources and principals that associated for resource shares that you own.
func (*Client) GetResourceShareInvitations ¶
func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
Retrieves details about invitations that you have received for resource shares.
func (*Client) GetResourceShares ¶
func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
Retrieves details about the resource shares that you own or that are shared with you.
func (*Client) ListPendingInvitationResources ¶
func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING . That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.
func (*Client) ListPermissionAssociations ¶
func (c *Client) ListPermissionAssociations(ctx context.Context, params *ListPermissionAssociationsInput, optFns ...func(*Options)) (*ListPermissionAssociationsOutput, error)
Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.
func (*Client) ListPermissionVersions ¶
func (c *Client) ListPermissionVersions(ctx context.Context, params *ListPermissionVersionsInput, optFns ...func(*Options)) (*ListPermissionVersionsOutput, error)
Lists the available versions of the specified RAM permission.
func (*Client) ListPermissions ¶
func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
func (*Client) ListPrincipals ¶
func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
Lists the principals that you are sharing resources with or that are sharing resources with you.
func (*Client) ListReplacePermissionAssociationsWork ¶
func (c *Client) ListReplacePermissionAssociationsWork(ctx context.Context, params *ListReplacePermissionAssociationsWorkInput, optFns ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error)
Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWorkoperation.
func (*Client) ListResourceSharePermissions ¶
func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
Lists the RAM permissions that are associated with a resource share.
func (*Client) ListResourceTypes ¶
func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
Lists the resource types that can be shared by RAM.
func (*Client) ListResources ¶
func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error)
Lists the resources that you added to a resource share or the resources that are shared with you.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PromotePermissionCreatedFromPolicy ¶
func (c *Client) PromotePermissionCreatedFromPolicy(ctx context.Context, params *PromotePermissionCreatedFromPolicyInput, optFns ...func(*Options)) (*PromotePermissionCreatedFromPolicyOutput, error)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet = CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.
This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.
Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.
The original CREATED_FROM_POLICY policy isn't deleted, and resource shares using that original policy aren't automatically updated.
You can't modify a CREATED_FROM_POLICY resource share so you can't associate the new customer managed permission by using ReplacePermsissionAssociations . However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promoted STANDARD resource share.
After you promote a resource share, if the original CREATED_FROM_POLICY managed permission has no other associations to A resource share, then RAM automatically deletes it.
func (*Client) PromoteResourceShareCreatedFromPolicy ¶
func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet = CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.
This operation promotes the resource share to a STANDARD resource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.
Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing CREATED_FROM_POLICY permission, then this operation fails.
func (*Client) RejectResourceShareInvitation ¶
func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, optFns ...func(*Options)) (*RejectResourceShareInvitationOutput, error)
Rejects an invitation to a resource share from another Amazon Web Services account.
func (*Client) ReplacePermissionAssociations ¶
func (c *Client) ReplacePermissionAssociations(ctx context.Context, params *ReplacePermissionAssociationsInput, optFns ...func(*Options)) (*ReplacePermissionAssociationsOutput, error)
Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.
You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the fromPermissionArn and toPermissionArn parameters.
You can use the optional fromPermissionVersion parameter to update only those resources that use a specified version of the managed permission to the new managed permission.
To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.
func (*Client) SetDefaultPermissionVersion ¶
func (c *Client) SetDefaultPermissionVersion(ctx context.Context, params *SetDefaultPermissionVersionInput, optFns ...func(*Options)) (*SetDefaultPermissionVersionOutput, error)
Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociationsto update them.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.
The tags on a managed permission are the same for all versions of the managed permission.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tag key and value pairs from the specified resource share or managed permission.
func (*Client) UpdateResourceShare ¶
func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResourceShareInput, optFns ...func(*Options)) (*UpdateResourceShareOutput, error)
Modifies some of the properties of the specified resource share.
type CreatePermissionInput ¶
type CreatePermissionInput struct { // Specifies the name of the customer managed permission. The name must be unique // within the Amazon Web Services Region. // // This member is required. Name *string // A string in JSON format string that contains the following elements of a // resource-based policy: // // - Effect: must be set to ALLOW . // // - Action: specifies the actions that are allowed by this customer managed // permission. The list must contain only actions that are supported by the // specified resource type. For a list of all actions supported by each resource // type, see [Actions, resources, and condition keys for Amazon Web Services services]in the Identity and Access Management User Guide. // // - Condition: (optional) specifies conditional parameters that must evaluate // to true when a user attempts an action for that action to be allowed. For more // information about the Condition element, see [IAM policies: Condition element]in the Identity and Access // Management User Guide. // // This template can't include either the Resource or Principal elements. Those // are both filled in by RAM when it instantiates the resource-based policy on each // resource shared using this managed permission. The Resource comes from the ARN // of the specific resource that you are sharing. The Principal comes from the // list of identities added to the resource share. // // [IAM policies: Condition element]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html // [Actions, resources, and condition keys for Amazon Web Services services]: https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html // // This member is required. PolicyTemplate *string // Specifies the name of the resource type that this customer managed permission // applies to. // // The format is : and is not case sensitive. For example, to specify an Amazon // EC2 Subnet, you can use the string ec2:subnet . To see the list of valid values // for this parameter, query the ListResourceTypesoperation. // // This member is required. ResourceType *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies a list of one or more tag key and value pairs to attach to the // permission. Tags []types.Tag // contains filtered or unexported fields }
type CreatePermissionOutput ¶
type CreatePermissionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // A structure with information about this customer managed permission. Permission *types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreatePermissionVersionInput ¶
type CreatePermissionVersionInput struct { // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission you're creating a new version // for. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // A string in JSON format string that contains the following elements of a // resource-based policy: // // - Effect: must be set to ALLOW . // // - Action: specifies the actions that are allowed by this customer managed // permission. The list must contain only actions that are supported by the // specified resource type. For a list of all actions supported by each resource // type, see [Actions, resources, and condition keys for Amazon Web Services services]in the Identity and Access Management User Guide. // // - Condition: (optional) specifies conditional parameters that must evaluate // to true when a user attempts an action for that action to be allowed. For more // information about the Condition element, see [IAM policies: Condition element]in the Identity and Access // Management User Guide. // // This template can't include either the Resource or Principal elements. Those // are both filled in by RAM when it instantiates the resource-based policy on each // resource shared using this managed permission. The Resource comes from the ARN // of the specific resource that you are sharing. The Principal comes from the // list of identities added to the resource share. // // [IAM policies: Condition element]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html // [Actions, resources, and condition keys for Amazon Web Services services]: https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html // // This member is required. PolicyTemplate *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type CreatePermissionVersionOutput ¶
type CreatePermissionVersionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // Information about a RAM managed permission. Permission *types.ResourceSharePermissionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateResourceShareInput ¶
type CreateResourceShareInput struct { // // This member is required. Name *string // associated with a resource share. A value of true lets you share with // individual Amazon Web Services accounts that are not in your organization. A // value of false only has meaning if your account is a member of an Amazon Web // Services Organization. The default value is true . AllowExternalPrincipals *bool // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // you do not specify an ARN for the permission, RAM automatically attaches the // default version of the permission for each resource type. You can associate only // one permission with each resource type included in the resource share. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArns []string // // You can include the following values: // // - An Amazon Web Services account ID, for example: 123456789012 // // - An [Amazon Resource Name (ARN)]of an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // - An ARN of an organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // - An ARN of an IAM role, for example: iam::123456789012:role/rolename // // - An ARN of an IAM user, for example: iam::123456789012user/username // // Not all resource types can be shared with IAM roles and users. For more // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // resource share. ResourceArns []string // resources in this resource share. Sources []string // attach the tags to the resources associated with the resource share. Tags []types.Tag // contains filtered or unexported fields }
type CreateResourceShareOutput ¶
type CreateResourceShareOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string ResourceShare *types.ResourceShare ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePermissionInput ¶
type DeletePermissionInput struct { // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission that you want to delete. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type DeletePermissionOutput ¶
type DeletePermissionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // This operation is performed asynchronously, and this response parameter // indicates the current status. PermissionStatus types.PermissionStatus // A boolean that indicates whether the delete operations succeeded. ReturnValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePermissionVersionInput ¶
type DeletePermissionVersionInput struct { // Specifies the [Amazon Resource Name (ARN)] of the permission with the version you want to delete. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the version number to delete. // // You can't delete the default version for a customer managed permission. // // You can't delete a version if it's the only version of the permission. You must // either first create another version, or delete the permission completely. // // You can't delete a version if it is attached to any resource shares. If the // version is the default, you must first use SetDefaultPermissionVersionto set a different version as the // default for the customer managed permission, and then use AssociateResourceSharePermissionto update your // resource shares to use the new default version. // // This member is required. PermissionVersion *int32 // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type DeletePermissionVersionOutput ¶
type DeletePermissionVersionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // This operation is performed asynchronously, and this response parameter // indicates the current status. PermissionStatus types.PermissionStatus // A boolean value that indicates whether the operation is successful. ReturnValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteResourceShareInput ¶
type DeleteResourceShareInput struct { // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type DeleteResourceShareOutput ¶
type DeleteResourceShareOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // indicates that the request failed. ReturnValue *bool ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateResourceShareInput ¶
type DisassociateResourceShareInput struct { // principals from. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // the resources in this resource share. // // You can include the following values: // // - An Amazon Web Services account ID, for example: 123456789012 // // - An [Amazon Resource Name (ARN)]of an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // - An ARN of an organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // - An ARN of an IAM role, for example: iam::123456789012:role/rolename // // - An ARN of an IAM user, for example: iam::123456789012user/username // // Not all resource types can be shared with IAM roles and users. For more // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // resource share. After the operation runs, these resources are no longer shared // with principals associated with the resource share. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // to the resources in this resource share. Sources []string // contains filtered or unexported fields }
type DisassociateResourceShareOutput ¶
type DisassociateResourceShareOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // resource share. ResourceShareAssociations []types.ResourceShareAssociation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateResourceSharePermissionInput ¶
type DisassociateResourceSharePermissionInput struct { // to permissions take effect immediately. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type DisassociateResourceSharePermissionOutput ¶
type DisassociateResourceSharePermissionOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // indicates that the request failed. ReturnValue *bool ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EnableSharingWithAwsOrganizationInput ¶
type EnableSharingWithAwsOrganizationInput struct {
// contains filtered or unexported fields
}
type EnableSharingWithAwsOrganizationOutput ¶
type EnableSharingWithAwsOrganizationOutput struct { // A return value of true indicates that the request succeeded. A value of false // indicates that the request failed. ReturnValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetPermissionInput ¶
type GetPermissionInput struct { // Specifies the [Amazon Resource Name (ARN)] of the permission whose contents you want to retrieve. To find // the ARN for a permission, use either the ListPermissionsoperation or go to the [Permissions library] page in the // RAM console and then choose the name of the permission. The ARN is displayed on // the detail page. // // [Permissions library]: https://console.aws.amazon.com/ram/home#Permissions: // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the version number of the RAM permission to retrieve. If you don't // specify this parameter, the operation retrieves the default version. // // To see the list of available versions, use ListPermissionVersions. PermissionVersion *int32 // contains filtered or unexported fields }
type GetPermissionOutput ¶
type GetPermissionOutput struct { // An object with details about the permission. Permission *types.ResourceSharePermissionDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesAPIClient ¶
type GetResourcePoliciesAPIClient interface {
GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error)
}
GetResourcePoliciesAPIClient is a client that implements the GetResourcePolicies operation.
type GetResourcePoliciesInput ¶
type GetResourcePoliciesInput struct { // Specifies the [Amazon Resource Names (ARNs)] of the resources whose policies you want to retrieve. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArns []string // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies the principal. Principal *string // contains filtered or unexported fields }
type GetResourcePoliciesOutput ¶
type GetResourcePoliciesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of resource policy documents in JSON format. Policies []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePoliciesPaginator ¶
type GetResourcePoliciesPaginator struct {
// contains filtered or unexported fields
}
GetResourcePoliciesPaginator is a paginator for GetResourcePolicies
func NewGetResourcePoliciesPaginator ¶
func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator
NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator
func (*GetResourcePoliciesPaginator) HasMorePages ¶
func (p *GetResourcePoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourcePoliciesPaginator) NextPage ¶
func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error)
NextPage retrieves the next GetResourcePolicies page.
type GetResourcePoliciesPaginatorOptions ¶
type GetResourcePoliciesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourcePoliciesPaginatorOptions is the paginator options for GetResourcePolicies
type GetResourceShareAssociationsAPIClient ¶
type GetResourceShareAssociationsAPIClient interface {
}GetResourceShareAssociationsAPIClient is a client that implements the GetResourceShareAssociations operation.
type GetResourceShareAssociationsInput ¶
type GetResourceShareAssociationsInput struct { // specified resource or principal. // // - PRINCIPAL – list the principals whose associations you want to see. // // - RESOURCE – list the resources whose associations you want to see. // // This member is required. AssociationType types.ResourceShareAssociationType AssociationStatus types.ResourceShareAssociationStatus // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // This can be an Amazon Web Services account ID, an organization ID, an // organizational unit ID, or the [Amazon Resource Name (ARN)]of an individual IAM role or user. // // You cannot specify this parameter if the association type is RESOURCE . // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Principal *string // // You cannot specify this parameter if the association type is PRINCIPAL . // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string // retrieve. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // contains filtered or unexported fields }
type GetResourceShareAssociationsOutput ¶
type GetResourceShareAssociationsOutput struct { // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string ResourceShareAssociations []types.ResourceShareAssociation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourceShareAssociationsPaginator ¶
type GetResourceShareAssociationsPaginator struct {
// contains filtered or unexported fields
}
GetResourceShareAssociationsPaginator is a paginator for GetResourceShareAssociations
func NewGetResourceShareAssociationsPaginator ¶
func NewGetResourceShareAssociationsPaginator(client GetResourceShareAssociationsAPIClient, params *GetResourceShareAssociationsInput, optFns ...func(*GetResourceShareAssociationsPaginatorOptions)) *GetResourceShareAssociationsPaginator
NewGetResourceShareAssociationsPaginator returns a new GetResourceShareAssociationsPaginator
func (*GetResourceShareAssociationsPaginator) HasMorePages ¶
func (p *GetResourceShareAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceShareAssociationsPaginator) NextPage ¶
func (p *GetResourceShareAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
NextPage retrieves the next GetResourceShareAssociations page.
type GetResourceShareAssociationsPaginatorOptions ¶
type GetResourceShareAssociationsPaginatorOptions struct { // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourceShareAssociationsPaginatorOptions is the paginator options for GetResourceShareAssociations
type GetResourceShareInvitationsAPIClient ¶
type GetResourceShareInvitationsAPIClient interface {
}GetResourceShareInvitationsAPIClient is a client that implements the GetResourceShareInvitations operation.
type GetResourceShareInvitationsInput ¶
type GetResourceShareInvitationsInput struct { // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // described by this list of [Amazon Resource Names (ARNs)] // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareInvitationArns []string // contains filtered or unexported fields }
type GetResourceShareInvitationsOutput ¶
type GetResourceShareInvitationsOutput struct { // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string ResourceShareInvitations []types.ResourceShareInvitation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourceShareInvitationsPaginator ¶
type GetResourceShareInvitationsPaginator struct {
// contains filtered or unexported fields
}
GetResourceShareInvitationsPaginator is a paginator for GetResourceShareInvitations
func NewGetResourceShareInvitationsPaginator ¶
func NewGetResourceShareInvitationsPaginator(client GetResourceShareInvitationsAPIClient, params *GetResourceShareInvitationsInput, optFns ...func(*GetResourceShareInvitationsPaginatorOptions)) *GetResourceShareInvitationsPaginator
NewGetResourceShareInvitationsPaginator returns a new GetResourceShareInvitationsPaginator
func (*GetResourceShareInvitationsPaginator) HasMorePages ¶
func (p *GetResourceShareInvitationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceShareInvitationsPaginator) NextPage ¶
func (p *GetResourceShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
NextPage retrieves the next GetResourceShareInvitations page.
type GetResourceShareInvitationsPaginatorOptions ¶
type GetResourceShareInvitationsPaginatorOptions struct { // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourceShareInvitationsPaginatorOptions is the paginator options for GetResourceShareInvitations
type GetResourceSharesAPIClient ¶
type GetResourceSharesAPIClient interface {
}GetResourceSharesAPIClient is a client that implements the GetResourceShares operation.
type GetResourceSharesInput ¶
type GetResourceSharesInput struct { // match the following: // // - SELF – resource shares that your account shares with other accounts // // - OTHER-ACCOUNTS – resource shares that other accounts share with your account // // This member is required. ResourceOwner types.ResourceOwner // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // details about. Name *string // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // use the managed permission with this [Amazon Resource Name (ARN)]. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArn *string // use the specified version of the managed permission. PermissionVersion *int32 // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // have this status. ResourceShareStatus types.ResourceShareStatus // match the specified tag keys and values. TagFilters []types.TagFilter // contains filtered or unexported fields }
type GetResourceSharesOutput ¶
type GetResourceSharesOutput struct { // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string ResourceShares []types.ResourceShare ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourceSharesPaginator ¶
type GetResourceSharesPaginator struct {
// contains filtered or unexported fields
}
GetResourceSharesPaginator is a paginator for GetResourceShares
func NewGetResourceSharesPaginator ¶
func NewGetResourceSharesPaginator(client GetResourceSharesAPIClient, params *GetResourceSharesInput, optFns ...func(*GetResourceSharesPaginatorOptions)) *GetResourceSharesPaginator
NewGetResourceSharesPaginator returns a new GetResourceSharesPaginator
func (*GetResourceSharesPaginator) HasMorePages ¶
func (p *GetResourceSharesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*GetResourceSharesPaginator) NextPage ¶
func (p *GetResourceSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceSharesOutput, error)
NextPage retrieves the next GetResourceShares page.
type GetResourceSharesPaginatorOptions ¶
type GetResourceSharesPaginatorOptions struct { // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
GetResourceSharesPaginatorOptions is the paginator options for GetResourceShares
type HTTPSignerV4 ¶
type ListPendingInvitationResourcesAPIClient ¶
type ListPendingInvitationResourcesAPIClient interface {
ListPendingInvitationResources(context.Context, *ListPendingInvitationResourcesInput, ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
}
ListPendingInvitationResourcesAPIClient is a client that implements the ListPendingInvitationResources operation.
type ListPendingInvitationResourcesInput ¶
type ListPendingInvitationResourcesInput struct { // invitation. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want the results to include only resources that have the // specified scope. // // - ALL – the results include both global and regional resources or resource // types. // // - GLOBAL – the results include only global resources or resource types. // // - REGIONAL – the results include only regional resources or resource types. // // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter // contains filtered or unexported fields }
type ListPendingInvitationResourcesOutput ¶
type ListPendingInvitationResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects that contain the information about the resources included // the specified resource share. Resources []types.Resource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPendingInvitationResourcesPaginator ¶
type ListPendingInvitationResourcesPaginator struct {
// contains filtered or unexported fields
}
ListPendingInvitationResourcesPaginator is a paginator for ListPendingInvitationResources
func NewListPendingInvitationResourcesPaginator ¶
func NewListPendingInvitationResourcesPaginator(client ListPendingInvitationResourcesAPIClient, params *ListPendingInvitationResourcesInput, optFns ...func(*ListPendingInvitationResourcesPaginatorOptions)) *ListPendingInvitationResourcesPaginator
NewListPendingInvitationResourcesPaginator returns a new ListPendingInvitationResourcesPaginator
func (*ListPendingInvitationResourcesPaginator) HasMorePages ¶
func (p *ListPendingInvitationResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPendingInvitationResourcesPaginator) NextPage ¶
func (p *ListPendingInvitationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
NextPage retrieves the next ListPendingInvitationResources page.
type ListPendingInvitationResourcesPaginatorOptions ¶
type ListPendingInvitationResourcesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPendingInvitationResourcesPaginatorOptions is the paginator options for ListPendingInvitationResources
type ListPermissionAssociationsAPIClient ¶
type ListPermissionAssociationsAPIClient interface {
ListPermissionAssociations(context.Context, *ListPermissionAssociationsInput, ...func(*Options)) (*ListPermissionAssociationsOutput, error)
}
ListPermissionAssociationsAPIClient is a client that implements the ListPermissionAssociations operation.
type ListPermissionAssociationsInput ¶
type ListPermissionAssociationsInput struct { // Specifies that you want to list only those associations with resource shares // that match this status. AssociationStatus types.ResourceShareAssociationStatus // When true , specifies that you want to list only those associations with // resource shares that use the default version of the specified managed // permission. // // When false (the default value), lists associations with resource shares that // use any version of the specified managed permission. DefaultVersion *bool // Specifies that you want to list only those associations with resource shares // that have a featureSet with this value. FeatureSet types.PermissionFeatureSet // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies the [Amazon Resource Name (ARN)] of the managed permission. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArn *string // Specifies that you want to list only those associations with resource shares // that use this version of the managed permission. If you don't provide a value // for this parameter, then the operation returns information about associations // with resource shares that use any version of the managed permission. PermissionVersion *int32 // Specifies that you want to list only those associations with resource shares // that include at least one resource of this resource type. ResourceType *string // contains filtered or unexported fields }
type ListPermissionAssociationsOutput ¶
type ListPermissionAssociationsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // A structure with information about this customer managed permission. Permissions []types.AssociatedPermission // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPermissionAssociationsPaginator ¶
type ListPermissionAssociationsPaginator struct {
// contains filtered or unexported fields
}
ListPermissionAssociationsPaginator is a paginator for ListPermissionAssociations
func NewListPermissionAssociationsPaginator ¶
func NewListPermissionAssociationsPaginator(client ListPermissionAssociationsAPIClient, params *ListPermissionAssociationsInput, optFns ...func(*ListPermissionAssociationsPaginatorOptions)) *ListPermissionAssociationsPaginator
NewListPermissionAssociationsPaginator returns a new ListPermissionAssociationsPaginator
func (*ListPermissionAssociationsPaginator) HasMorePages ¶
func (p *ListPermissionAssociationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPermissionAssociationsPaginator) NextPage ¶
func (p *ListPermissionAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionAssociationsOutput, error)
NextPage retrieves the next ListPermissionAssociations page.
type ListPermissionAssociationsPaginatorOptions ¶
type ListPermissionAssociationsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPermissionAssociationsPaginatorOptions is the paginator options for ListPermissionAssociations
type ListPermissionVersionsAPIClient ¶
type ListPermissionVersionsAPIClient interface {
ListPermissionVersions(context.Context, *ListPermissionVersionsInput, ...func(*Options)) (*ListPermissionVersionsOutput, error)
}
ListPermissionVersionsAPIClient is a client that implements the ListPermissionVersions operation.
type ListPermissionVersionsInput ¶
type ListPermissionVersionsInput struct { // Specifies the [Amazon Resource Name (ARN)] of the RAM permission whose versions you want to list. You can // use the permissionVersion parameter on the AssociateResourceSharePermission operation to specify a non-default // version to attach. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // contains filtered or unexported fields }
type ListPermissionVersionsOutput ¶
type ListPermissionVersionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects that contain details for each of the available versions. Permissions []types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPermissionVersionsPaginator ¶
type ListPermissionVersionsPaginator struct {
// contains filtered or unexported fields
}
ListPermissionVersionsPaginator is a paginator for ListPermissionVersions
func NewListPermissionVersionsPaginator ¶
func NewListPermissionVersionsPaginator(client ListPermissionVersionsAPIClient, params *ListPermissionVersionsInput, optFns ...func(*ListPermissionVersionsPaginatorOptions)) *ListPermissionVersionsPaginator
NewListPermissionVersionsPaginator returns a new ListPermissionVersionsPaginator
func (*ListPermissionVersionsPaginator) HasMorePages ¶
func (p *ListPermissionVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPermissionVersionsPaginator) NextPage ¶
func (p *ListPermissionVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionVersionsOutput, error)
NextPage retrieves the next ListPermissionVersions page.
type ListPermissionVersionsPaginatorOptions ¶
type ListPermissionVersionsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPermissionVersionsPaginatorOptions is the paginator options for ListPermissionVersions
type ListPermissionsAPIClient ¶
type ListPermissionsAPIClient interface {
ListPermissions(context.Context, *ListPermissionsInput, ...func(*Options)) (*ListPermissionsOutput, error)
}
ListPermissionsAPIClient is a client that implements the ListPermissions operation.
type ListPermissionsInput ¶
type ListPermissionsInput struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list only permissions of this type: // // - AWS – returns only Amazon Web Services managed permissions. // // - LOCAL – returns only customer managed permissions // // - ALL – returns both Amazon Web Services managed permissions and customer // managed permissions. // // If you don't specify this parameter, the default is All . PermissionType types.PermissionTypeFilter // Specifies that you want to list only those permissions that apply to the // specified resource type. This parameter is not case sensitive. // // For example, to list only permissions that apply to Amazon EC2 subnets, specify // ec2:subnet . You can use the ListResourceTypes operation to get the specific string required. ResourceType *string // contains filtered or unexported fields }
type ListPermissionsOutput ¶
type ListPermissionsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects with information about the permissions. Permissions []types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPermissionsPaginator ¶
type ListPermissionsPaginator struct {
// contains filtered or unexported fields
}
ListPermissionsPaginator is a paginator for ListPermissions
func NewListPermissionsPaginator ¶
func NewListPermissionsPaginator(client ListPermissionsAPIClient, params *ListPermissionsInput, optFns ...func(*ListPermissionsPaginatorOptions)) *ListPermissionsPaginator
NewListPermissionsPaginator returns a new ListPermissionsPaginator
func (*ListPermissionsPaginator) HasMorePages ¶
func (p *ListPermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPermissionsPaginator) NextPage ¶
func (p *ListPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionsOutput, error)
NextPage retrieves the next ListPermissions page.
type ListPermissionsPaginatorOptions ¶
type ListPermissionsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPermissionsPaginatorOptions is the paginator options for ListPermissions
type ListPrincipalsAPIClient ¶
type ListPrincipalsAPIClient interface {
ListPrincipals(context.Context, *ListPrincipalsInput, ...func(*Options)) (*ListPrincipalsOutput, error)
}
ListPrincipalsAPIClient is a client that implements the ListPrincipals operation.
type ListPrincipalsInput ¶
type ListPrincipalsInput struct { // Specifies that you want to list information for only resource shares that match // the following: // // - SELF – principals that your account is sharing resources with // // - OTHER-ACCOUNTS – principals that are sharing resources with your account // // This member is required. ResourceOwner types.ResourceOwner // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list information for only the listed principals. // // You can include the following values: // // - An Amazon Web Services account ID, for example: 123456789012 // // - An [Amazon Resource Name (ARN)]of an organization in Organizations, for example: // organizations::123456789012:organization/o-exampleorgid // // - An ARN of an organizational unit (OU) in Organizations, for example: // organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123 // // - An ARN of an IAM role, for example: iam::123456789012:role/rolename // // - An ARN of an IAM user, for example: iam::123456789012user/username // // Not all resource types can be shared with IAM roles and users. For more // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // Specifies that you want to list principal information for the resource share // with the specified [Amazon Resource Name (ARN)]. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string // the resource shares specified by a list the [Amazon Resource Names (ARNs)]. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // Specifies that you want to list information for only principals associated with // resource shares that include the specified resource type. // // For a list of valid values, query the ListResourceTypes operation. ResourceType *string // contains filtered or unexported fields }
type ListPrincipalsOutput ¶
type ListPrincipalsOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects that contain the details about the principals. Principals []types.Principal // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPrincipalsPaginator ¶
type ListPrincipalsPaginator struct {
// contains filtered or unexported fields
}
ListPrincipalsPaginator is a paginator for ListPrincipals
func NewListPrincipalsPaginator ¶
func NewListPrincipalsPaginator(client ListPrincipalsAPIClient, params *ListPrincipalsInput, optFns ...func(*ListPrincipalsPaginatorOptions)) *ListPrincipalsPaginator
NewListPrincipalsPaginator returns a new ListPrincipalsPaginator
func (*ListPrincipalsPaginator) HasMorePages ¶
func (p *ListPrincipalsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPrincipalsPaginator) NextPage ¶
func (p *ListPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsOutput, error)
NextPage retrieves the next ListPrincipals page.
type ListPrincipalsPaginatorOptions ¶
type ListPrincipalsPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListPrincipalsPaginatorOptions is the paginator options for ListPrincipals
type ListReplacePermissionAssociationsWorkAPIClient ¶
type ListReplacePermissionAssociationsWorkAPIClient interface {
ListReplacePermissionAssociationsWork(context.Context, *ListReplacePermissionAssociationsWorkInput, ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error)
}
ListReplacePermissionAssociationsWorkAPIClient is a client that implements the ListReplacePermissionAssociationsWork operation.
type ListReplacePermissionAssociationsWorkInput ¶
type ListReplacePermissionAssociationsWorkInput struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to see only the details about requests with a status // that matches this value. Status types.ReplacePermissionAssociationsWorkStatus // A list of IDs. These values come from the id field of the // replacePermissionAssociationsWork structure returned by the ReplacePermissionAssociations operation. WorkIds []string // contains filtered or unexported fields }
type ListReplacePermissionAssociationsWorkOutput ¶
type ListReplacePermissionAssociationsWorkOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of data structures that provide details of the matching work IDs. ReplacePermissionAssociationsWorks []types.ReplacePermissionAssociationsWork // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListReplacePermissionAssociationsWorkPaginator ¶
type ListReplacePermissionAssociationsWorkPaginator struct {
// contains filtered or unexported fields
}
ListReplacePermissionAssociationsWorkPaginator is a paginator for ListReplacePermissionAssociationsWork
func NewListReplacePermissionAssociationsWorkPaginator ¶
func NewListReplacePermissionAssociationsWorkPaginator(client ListReplacePermissionAssociationsWorkAPIClient, params *ListReplacePermissionAssociationsWorkInput, optFns ...func(*ListReplacePermissionAssociationsWorkPaginatorOptions)) *ListReplacePermissionAssociationsWorkPaginator
NewListReplacePermissionAssociationsWorkPaginator returns a new ListReplacePermissionAssociationsWorkPaginator
func (*ListReplacePermissionAssociationsWorkPaginator) HasMorePages ¶
func (p *ListReplacePermissionAssociationsWorkPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListReplacePermissionAssociationsWorkPaginator) NextPage ¶
func (p *ListReplacePermissionAssociationsWorkPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error)
NextPage retrieves the next ListReplacePermissionAssociationsWork page.
type ListReplacePermissionAssociationsWorkPaginatorOptions ¶
type ListReplacePermissionAssociationsWorkPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListReplacePermissionAssociationsWorkPaginatorOptions is the paginator options for ListReplacePermissionAssociationsWork
type ListResourceSharePermissionsAPIClient ¶
type ListResourceSharePermissionsAPIClient interface {
}ListResourceSharePermissionsAPIClient is a client that implements the ListResourceSharePermissions operation.
type ListResourceSharePermissionsInput ¶
type ListResourceSharePermissionsInput struct { // associated permissions. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // contains filtered or unexported fields }
type ListResourceSharePermissionsOutput ¶
type ListResourceSharePermissionsOutput struct { // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // share. Permissions []types.ResourceSharePermissionSummary ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourceSharePermissionsPaginator ¶
type ListResourceSharePermissionsPaginator struct {
// contains filtered or unexported fields
}
ListResourceSharePermissionsPaginator is a paginator for ListResourceSharePermissions
func NewListResourceSharePermissionsPaginator ¶
func NewListResourceSharePermissionsPaginator(client ListResourceSharePermissionsAPIClient, params *ListResourceSharePermissionsInput, optFns ...func(*ListResourceSharePermissionsPaginatorOptions)) *ListResourceSharePermissionsPaginator
NewListResourceSharePermissionsPaginator returns a new ListResourceSharePermissionsPaginator
func (*ListResourceSharePermissionsPaginator) HasMorePages ¶
func (p *ListResourceSharePermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceSharePermissionsPaginator) NextPage ¶
func (p *ListResourceSharePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
NextPage retrieves the next ListResourceSharePermissions page.
type ListResourceSharePermissionsPaginatorOptions ¶
type ListResourceSharePermissionsPaginatorOptions struct { // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourceSharePermissionsPaginatorOptions is the paginator options for ListResourceSharePermissions
type ListResourceTypesAPIClient ¶
type ListResourceTypesAPIClient interface {
ListResourceTypes(context.Context, *ListResourceTypesInput, ...func(*Options)) (*ListResourceTypesOutput, error)
}
ListResourceTypesAPIClient is a client that implements the ListResourceTypes operation.
type ListResourceTypesInput ¶
type ListResourceTypesInput struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want the results to include only resources that have the // specified scope. // // - ALL – the results include both global and regional resources or resource // types. // // - GLOBAL – the results include only global resources or resource types. // // - REGIONAL – the results include only regional resources or resource types. // // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter // contains filtered or unexported fields }
type ListResourceTypesOutput ¶
type ListResourceTypesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects that contain information about the resource types that can // be shared using RAM. ResourceTypes []types.ServiceNameAndResourceType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourceTypesPaginator ¶
type ListResourceTypesPaginator struct {
// contains filtered or unexported fields
}
ListResourceTypesPaginator is a paginator for ListResourceTypes
func NewListResourceTypesPaginator ¶
func NewListResourceTypesPaginator(client ListResourceTypesAPIClient, params *ListResourceTypesInput, optFns ...func(*ListResourceTypesPaginatorOptions)) *ListResourceTypesPaginator
NewListResourceTypesPaginator returns a new ListResourceTypesPaginator
func (*ListResourceTypesPaginator) HasMorePages ¶
func (p *ListResourceTypesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourceTypesPaginator) NextPage ¶
func (p *ListResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTypesOutput, error)
NextPage retrieves the next ListResourceTypes page.
type ListResourceTypesPaginatorOptions ¶
type ListResourceTypesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourceTypesPaginatorOptions is the paginator options for ListResourceTypes
type ListResourcesAPIClient ¶
type ListResourcesAPIClient interface {
ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}
ListResourcesAPIClient is a client that implements the ListResources operation.
type ListResourcesInput ¶
type ListResourcesInput struct { // Specifies that you want to list only the resource shares that match the // following: // // - SELF – resources that your account shares with other accounts // // - OTHER-ACCOUNTS – resources that other accounts share with your account // // This member is required. ResourceOwner types.ResourceOwner // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you // received a NextToken response in the previous request. If you did, it indicates // that more output is available. Set this parameter to the value provided by the // previous call's NextToken response to request the next page of results. NextToken *string // Specifies that you want to list only the resource shares that are associated // with the specified principal. Principal *string // Specifies that you want to list only the resource shares that include resources // with the specified [Amazon Resource Names (ARNs)]. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // Specifies that you want the results to include only resources that have the // specified scope. // // - ALL – the results include both global and regional resources or resource // types. // // - GLOBAL – the results include only global resources or resource types. // // - REGIONAL – the results include only regional resources or resource types. // // The default value is ALL . ResourceRegionScope types.ResourceRegionScopeFilter // identified by the specified [Amazon Resource Names (ARNs)]. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // Specifies that you want to list only the resource shares that include resources // of the specified resource type. // // For valid values, query the ListResourceTypes operation. ResourceType *string // contains filtered or unexported fields }
type ListResourcesOutput ¶
type ListResourcesOutput struct { // If present, this value indicates that more output is available than is included // in the current response. Use this value in the NextToken request parameter in a // subsequent call to the operation to get the next part of the output. You should // repeat this until the NextToken response element comes back as null . This // indicates that this is the last page of results. NextToken *string // An array of objects that contain information about the resources. Resources []types.Resource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourcesPaginator ¶
type ListResourcesPaginator struct {
// contains filtered or unexported fields
}
ListResourcesPaginator is a paginator for ListResources
func NewListResourcesPaginator ¶
func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator
NewListResourcesPaginator returns a new ListResourcesPaginator
func (*ListResourcesPaginator) HasMorePages ¶
func (p *ListResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourcesPaginator) NextPage ¶
func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error)
NextPage retrieves the next ListResources page.
type ListResourcesPaginatorOptions ¶
type ListResourcesPaginatorOptions struct { // Specifies the total number of results that you want included on each page of // the response. If you do not include this parameter, it defaults to a value that // is specific to the operation. If additional items exist beyond the number you // specify, the NextToken response element is returned with a value (not null). // Include the specified value as the NextToken request parameter in the next call // to the operation to get the next part of the results. Note that the service // might return fewer results than the maximum even when there are more results // available. You should check NextToken after every operation to ensure that you // receive all of the results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListResourcesPaginatorOptions is the paginator options for ListResources
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PromotePermissionCreatedFromPolicyInput ¶
type PromotePermissionCreatedFromPolicyInput struct { // Specifies a name for the promoted customer managed permission. // // This member is required. Name *string // Specifies the [Amazon Resource Name (ARN)] of the CREATED_FROM_POLICY permission that you want to promote. // You can get this [Amazon Resource Name (ARN)]by calling the ListResourceSharePermissions operation. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type PromotePermissionCreatedFromPolicyOutput ¶
type PromotePermissionCreatedFromPolicyOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // Information about an RAM permission. Permission *types.ResourceSharePermissionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PromoteResourceShareCreatedFromPolicyInput ¶
type PromoteResourceShareCreatedFromPolicyInput struct { // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // contains filtered or unexported fields }
type PromoteResourceShareCreatedFromPolicyOutput ¶
type PromoteResourceShareCreatedFromPolicyOutput struct { // indicates that the request failed. ReturnValue *bool ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RejectResourceShareInvitationInput ¶
type RejectResourceShareInvitationInput struct { // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type RejectResourceShareInvitationOutput ¶
type RejectResourceShareInvitationOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string ResourceShareInvitation *types.ResourceShareInvitation ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ReplacePermissionAssociationsInput ¶
type ReplacePermissionAssociationsInput struct { // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to replace. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. FromPermissionArn *string // Specifies the ARN of the managed permission that you want to associate with // resource shares in place of the one specified by fromPerssionArn and // fromPermissionVersion . // // The operation always associates the version that is currently the default for // the specified managed permission. // // This member is required. ToPermissionArn *string // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies that you want to updated the permissions for only those resource // shares that use the specified version of the managed permission. FromPermissionVersion *int32 // contains filtered or unexported fields }
type ReplacePermissionAssociationsOutput ¶
type ReplacePermissionAssociationsOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // Specifies a data structure that you can use to track the asynchronous tasks // that RAM performs to complete this operation. You can use the ListReplacePermissionAssociationsWorkoperation and // pass the id value returned in this structure. ReplacePermissionAssociationsWork *types.ReplacePermissionAssociationsWork // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type SetDefaultPermissionVersionInput ¶
type SetDefaultPermissionVersionInput struct { // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission whose default version you // want to change. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the version number that you want to designate as the default for // customer managed permission. To see a list of all available version numbers, use // ListPermissionVersions. // // This member is required. PermissionVersion *int32 // Specifies a unique, case-sensitive identifier that you provide to ensure the // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // contains filtered or unexported fields }
type SetDefaultPermissionVersionOutput ¶
type SetDefaultPermissionVersionOutput struct { // The idempotency identifier associated with this request. If you want to repeat // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string // A boolean value that indicates whether the operation was successful. ReturnValue *bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // A list of one or more tag key and value pairs. The tag key must be present and // not be an empty string. The tag value must be present but can be an empty // string. // // This member is required. Tags []types.Tag // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to add tags to. You must // specify either resourceArn , or resourceShareArn , but not both. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string // specify either resourceShareArn , or resourceArn , but not both. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // Specifies a list of one or more tag keys that you want to remove. // // This member is required. TagKeys []string // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to remove tags from. You // must specify either resourceArn , or resourceShareArn , but not both. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string // tags are removed from the resource share, not the resources in the resource // share. You must specify either resourceShareArn , or resourceArn , but not both. // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateResourceShareInput ¶
type UpdateResourceShareInput struct { // // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string // associated with a resource share. AllowExternalPrincipals *bool // idempotency of the request. This lets you safely retry the request without // accidentally performing the same operation a second time. Passing the same value // to a later call to an operation requires that you also pass the same value for // all other parameters. We recommend that you use a [UUID type of value.]. // // If you don't provide this value, then Amazon Web Services generates a random // one for you. // // If you retry the operation with the same ClientToken , but with different // parameters, the retry fails with an IdempotentParameterMismatch error. // // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string Name *string // contains filtered or unexported fields }
type UpdateResourceShareOutput ¶
type UpdateResourceShareOutput struct { // the same operation in an idempotent manner then you must include this value in // the clientToken request parameter of that later call. All other parameters must // also have the same values that you used in the first call. ClientToken *string ResourceShare *types.ResourceShare ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_AcceptResourceShareInvitation.go
- api_op_AssociateResourceShare.go
- api_op_AssociateResourceSharePermission.go
- api_op_CreatePermission.go
- api_op_CreatePermissionVersion.go
- api_op_CreateResourceShare.go
- api_op_DeletePermission.go
- api_op_DeletePermissionVersion.go
- api_op_DeleteResourceShare.go
- api_op_DisassociateResourceShare.go
- api_op_DisassociateResourceSharePermission.go
- api_op_EnableSharingWithAwsOrganization.go
- api_op_GetPermission.go
- api_op_GetResourcePolicies.go
- api_op_GetResourceShareAssociations.go
- api_op_GetResourceShareInvitations.go
- api_op_GetResourceShares.go
- api_op_ListPendingInvitationResources.go
- api_op_ListPermissionAssociations.go
- api_op_ListPermissionVersions.go
- api_op_ListPermissions.go
- api_op_ListPrincipals.go
- api_op_ListReplacePermissionAssociationsWork.go
- api_op_ListResourceSharePermissions.go
- api_op_ListResourceTypes.go
- api_op_ListResources.go
- api_op_PromotePermissionCreatedFromPolicy.go
- api_op_PromoteResourceShareCreatedFromPolicy.go
- api_op_RejectResourceShareInvitation.go
- api_op_ReplacePermissionAssociations.go
- api_op_SetDefaultPermissionVersion.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateResourceShare.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go