Documentation ¶
Overview ¶
Package ssmsap provides the API client, operations, and parameter types for AWS Systems Manager for SAP.
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.
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 AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) DeleteResourcePermission(ctx context.Context, params *DeleteResourcePermissionInput, ...) (*DeleteResourcePermissionOutput, error)
- func (c *Client) DeregisterApplication(ctx context.Context, params *DeregisterApplicationInput, ...) (*DeregisterApplicationOutput, error)
- func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
- func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error)
- func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optFns ...func(*Options)) (*GetDatabaseOutput, error)
- func (c *Client) GetOperation(ctx context.Context, params *GetOperationInput, optFns ...func(*Options)) (*GetOperationOutput, error)
- func (c *Client) GetResourcePermission(ctx context.Context, params *GetResourcePermissionInput, ...) (*GetResourcePermissionOutput, error)
- func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
- func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error)
- func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error)
- func (c *Client) ListOperationEvents(ctx context.Context, params *ListOperationEventsInput, ...) (*ListOperationEventsOutput, error)
- func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutResourcePermission(ctx context.Context, params *PutResourcePermissionInput, ...) (*PutResourcePermissionOutput, error)
- func (c *Client) RegisterApplication(ctx context.Context, params *RegisterApplicationInput, ...) (*RegisterApplicationOutput, error)
- func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
- func (c *Client) StartApplicationRefresh(ctx context.Context, params *StartApplicationRefreshInput, ...) (*StartApplicationRefreshOutput, error)
- func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, 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) UpdateApplicationSettings(ctx context.Context, params *UpdateApplicationSettingsInput, ...) (*UpdateApplicationSettingsOutput, error)
- type DeleteResourcePermissionInput
- type DeleteResourcePermissionOutput
- type DeregisterApplicationInput
- type DeregisterApplicationOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetApplicationInput
- type GetApplicationOutput
- type GetComponentInput
- type GetComponentOutput
- type GetDatabaseInput
- type GetDatabaseOutput
- type GetOperationInput
- type GetOperationOutput
- type GetResourcePermissionInput
- type GetResourcePermissionOutput
- type HTTPClient
- type HTTPSignerV4
- type ListApplicationsAPIClient
- type ListApplicationsInput
- type ListApplicationsOutput
- type ListApplicationsPaginator
- type ListApplicationsPaginatorOptions
- type ListComponentsAPIClient
- type ListComponentsInput
- type ListComponentsOutput
- type ListComponentsPaginator
- type ListComponentsPaginatorOptions
- type ListDatabasesAPIClient
- type ListDatabasesInput
- type ListDatabasesOutput
- type ListDatabasesPaginator
- type ListDatabasesPaginatorOptions
- type ListOperationEventsAPIClient
- type ListOperationEventsInput
- type ListOperationEventsOutput
- type ListOperationEventsPaginator
- type ListOperationEventsPaginatorOptions
- type ListOperationsAPIClient
- type ListOperationsInput
- type ListOperationsOutput
- type ListOperationsPaginator
- type ListOperationsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type PutResourcePermissionInput
- type PutResourcePermissionOutput
- type RegisterApplicationInput
- type RegisterApplicationOutput
- type ResolveEndpoint
- type StartApplicationInput
- type StartApplicationOutput
- type StartApplicationRefreshInput
- type StartApplicationRefreshOutput
- type StopApplicationInput
- type StopApplicationOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApplicationSettingsInput
- type UpdateApplicationSettingsOutput
Constants ¶
const ServiceAPIVersion = "2018-05-10"
const ServiceID = "Ssm Sap"
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 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 Systems Manager for SAP.
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) DeleteResourcePermission ¶
func (c *Client) DeleteResourcePermission(ctx context.Context, params *DeleteResourcePermissionInput, optFns ...func(*Options)) (*DeleteResourcePermissionOutput, error)
Removes permissions associated with the target database.
func (*Client) DeregisterApplication ¶
func (c *Client) DeregisterApplication(ctx context.Context, params *DeregisterApplicationInput, optFns ...func(*Options)) (*DeregisterApplicationOutput, error)
Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
func (*Client) GetApplication ¶
func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error)
Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
func (*Client) GetComponent ¶
func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error)
Gets the component of an application registered with AWS Systems Manager for SAP.
func (*Client) GetDatabase ¶
func (c *Client) GetDatabase(ctx context.Context, params *GetDatabaseInput, optFns ...func(*Options)) (*GetDatabaseOutput, error)
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
func (*Client) GetOperation ¶
func (c *Client) GetOperation(ctx context.Context, params *GetOperationInput, optFns ...func(*Options)) (*GetOperationOutput, error)
Gets the details of an operation by specifying the operation ID.
func (*Client) GetResourcePermission ¶
func (c *Client) GetResourcePermission(ctx context.Context, params *GetResourcePermissionInput, optFns ...func(*Options)) (*GetResourcePermissionOutput, error)
Gets permissions associated with the target database.
func (*Client) ListApplications ¶
func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)
Lists all the applications registered with AWS Systems Manager for SAP.
func (*Client) ListComponents ¶
func (c *Client) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error)
Lists all the components registered with AWS Systems Manager for SAP.
func (*Client) ListDatabases ¶
func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error)
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
func (*Client) ListOperationEvents ¶
func (c *Client) ListOperationEvents(ctx context.Context, params *ListOperationEventsInput, optFns ...func(*Options)) (*ListOperationEventsOutput, error)
Returns a list of operations events.
Available parameters include OperationID , as well as optional parameters MaxResults , NextToken , and Filters .
func (*Client) ListOperations ¶
func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error)
Lists the operations performed by AWS Systems Manager for SAP.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
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) PutResourcePermission ¶
func (c *Client) PutResourcePermission(ctx context.Context, params *PutResourcePermissionInput, optFns ...func(*Options)) (*PutResourcePermissionOutput, error)
Adds permissions to the target database.
func (*Client) RegisterApplication ¶
func (c *Client) RegisterApplication(ctx context.Context, params *RegisterApplicationInput, optFns ...func(*Options)) (*RegisterApplicationOutput, error)
Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
func (*Client) StartApplication ¶
func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error)
Request is an operation which starts an application.
Parameter ApplicationId is required.
func (*Client) StartApplicationRefresh ¶
func (c *Client) StartApplicationRefresh(ctx context.Context, params *StartApplicationRefreshInput, optFns ...func(*Options)) (*StartApplicationRefreshOutput, error)
Refreshes a registered application.
func (*Client) StopApplication ¶
func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error)
Request is an operation to stop an application.
Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Creates tag for a resource by specifying the ARN.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Delete the tags for a resource.
func (*Client) UpdateApplicationSettings ¶
func (c *Client) UpdateApplicationSettings(ctx context.Context, params *UpdateApplicationSettingsInput, optFns ...func(*Options)) (*UpdateApplicationSettingsOutput, error)
Updates the settings of an application registered with AWS Systems Manager for SAP.
type DeleteResourcePermissionInput ¶
type DeleteResourcePermissionInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // Delete or restore the permissions on the target database. ActionType types.PermissionActionType // The Amazon Resource Name (ARN) of the source resource. SourceResourceArn *string // contains filtered or unexported fields }
type DeleteResourcePermissionOutput ¶
type DeleteResourcePermissionOutput struct { // The policy that removes permissions on the target database. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeregisterApplicationInput ¶
type DeregisterApplicationInput struct { // The ID of the application. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type DeregisterApplicationOutput ¶
type DeregisterApplicationOutput struct { // 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 GetApplicationInput ¶
type GetApplicationOutput ¶
type GetApplicationOutput struct { // Returns all of the metadata of an application registered with AWS Systems // Manager for SAP. Application *types.Application // The tags of a registered application. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetComponentInput ¶
type GetComponentOutput ¶
type GetComponentOutput struct { // The component of an application registered with AWS Systems Manager for SAP. Component *types.Component // The tags of a component. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetDatabaseInput ¶
type GetDatabaseOutput ¶
type GetDatabaseOutput struct { // The SAP HANA database of an application registered with AWS Systems Manager for // SAP. Database *types.Database // The tags of a database. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOperationInput ¶
type GetOperationInput struct { // The ID of the operation. // // This member is required. OperationId *string // contains filtered or unexported fields }
type GetOperationOutput ¶
type GetOperationOutput struct { // Returns the details of an operation. Operation *types.Operation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetResourcePermissionInput ¶
type GetResourcePermissionInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // ActionType types.PermissionActionType // contains filtered or unexported fields }
type GetResourcePermissionOutput ¶
type GetResourcePermissionOutput struct { // Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type ListApplicationsAPIClient ¶
type ListApplicationsAPIClient interface {
ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
}
ListApplicationsAPIClient is a client that implements the ListApplications operation.
type ListApplicationsInput ¶
type ListApplicationsInput struct { // The filter of name, value, and operator. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int32 // The token for the next page of results. NextToken *string // contains filtered or unexported fields }
type ListApplicationsOutput ¶
type ListApplicationsOutput struct { // The applications registered with AWS Systems Manager for SAP. Applications []types.ApplicationSummary // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApplicationsPaginator ¶
type ListApplicationsPaginator struct {
// contains filtered or unexported fields
}
ListApplicationsPaginator is a paginator for ListApplications
func NewListApplicationsPaginator ¶
func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator
NewListApplicationsPaginator returns a new ListApplicationsPaginator
func (*ListApplicationsPaginator) HasMorePages ¶
func (p *ListApplicationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApplicationsPaginator) NextPage ¶
func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)
NextPage retrieves the next ListApplications page.
type ListApplicationsPaginatorOptions ¶
type ListApplicationsPaginatorOptions struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListApplicationsPaginatorOptions is the paginator options for ListApplications
type ListComponentsAPIClient ¶
type ListComponentsAPIClient interface {
ListComponents(context.Context, *ListComponentsInput, ...func(*Options)) (*ListComponentsOutput, error)
}
ListComponentsAPIClient is a client that implements the ListComponents operation.
type ListComponentsInput ¶
type ListComponentsInput struct { // The ID of the application. ApplicationId *string // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. // // If you do not specify a value for MaxResults, the request returns 50 items per // page by default. MaxResults *int32 // The token for the next page of results. NextToken *string // contains filtered or unexported fields }
type ListComponentsOutput ¶
type ListComponentsOutput struct { // List of components registered with AWS System Manager for SAP. Components []types.ComponentSummary // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListComponentsPaginator ¶
type ListComponentsPaginator struct {
// contains filtered or unexported fields
}
ListComponentsPaginator is a paginator for ListComponents
func NewListComponentsPaginator ¶
func NewListComponentsPaginator(client ListComponentsAPIClient, params *ListComponentsInput, optFns ...func(*ListComponentsPaginatorOptions)) *ListComponentsPaginator
NewListComponentsPaginator returns a new ListComponentsPaginator
func (*ListComponentsPaginator) HasMorePages ¶
func (p *ListComponentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListComponentsPaginator) NextPage ¶
func (p *ListComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListComponentsOutput, error)
NextPage retrieves the next ListComponents page.
type ListComponentsPaginatorOptions ¶
type ListComponentsPaginatorOptions struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. // // If you do not specify a value for MaxResults, the request returns 50 items per // page by default. 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 }
ListComponentsPaginatorOptions is the paginator options for ListComponents
type ListDatabasesAPIClient ¶
type ListDatabasesAPIClient interface {
ListDatabases(context.Context, *ListDatabasesInput, ...func(*Options)) (*ListDatabasesOutput, error)
}
ListDatabasesAPIClient is a client that implements the ListDatabases operation.
type ListDatabasesInput ¶
type ListDatabasesInput struct { // The ID of the application. ApplicationId *string // The ID of the component. ComponentId *string // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If you // do not specify a value for MaxResults, the request returns 50 items per page by // default. MaxResults *int32 // The token for the next page of results. NextToken *string // contains filtered or unexported fields }
type ListDatabasesOutput ¶
type ListDatabasesOutput struct { // The SAP HANA databases of an application. Databases []types.DatabaseSummary // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDatabasesPaginator ¶
type ListDatabasesPaginator struct {
// contains filtered or unexported fields
}
ListDatabasesPaginator is a paginator for ListDatabases
func NewListDatabasesPaginator ¶
func NewListDatabasesPaginator(client ListDatabasesAPIClient, params *ListDatabasesInput, optFns ...func(*ListDatabasesPaginatorOptions)) *ListDatabasesPaginator
NewListDatabasesPaginator returns a new ListDatabasesPaginator
func (*ListDatabasesPaginator) HasMorePages ¶
func (p *ListDatabasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDatabasesPaginator) NextPage ¶
func (p *ListDatabasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatabasesOutput, error)
NextPage retrieves the next ListDatabases page.
type ListDatabasesPaginatorOptions ¶
type ListDatabasesPaginatorOptions struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If you // do not specify a value for MaxResults, the request returns 50 items per page by // default. 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 }
ListDatabasesPaginatorOptions is the paginator options for ListDatabases
type ListOperationEventsAPIClient ¶
type ListOperationEventsAPIClient interface {
ListOperationEvents(context.Context, *ListOperationEventsInput, ...func(*Options)) (*ListOperationEventsOutput, error)
}
ListOperationEventsAPIClient is a client that implements the ListOperationEvents operation.
type ListOperationEventsInput ¶
type ListOperationEventsInput struct { // The ID of the operation. // // This member is required. OperationId *string // Optionally specify filters to narrow the returned operation event items. // // Valid filter names include status , resourceID , and resourceType . The valid // operator for all three filters is Equals . Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. // // If you do not specify a value for MaxResults , the request returns 50 items per // page by default. MaxResults *int32 // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // contains filtered or unexported fields }
type ListOperationEventsOutput ¶
type ListOperationEventsOutput struct { // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // A returned list of operation events that meet the filter criteria. OperationEvents []types.OperationEvent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOperationEventsPaginator ¶
type ListOperationEventsPaginator struct {
// contains filtered or unexported fields
}
ListOperationEventsPaginator is a paginator for ListOperationEvents
func NewListOperationEventsPaginator ¶
func NewListOperationEventsPaginator(client ListOperationEventsAPIClient, params *ListOperationEventsInput, optFns ...func(*ListOperationEventsPaginatorOptions)) *ListOperationEventsPaginator
NewListOperationEventsPaginator returns a new ListOperationEventsPaginator
func (*ListOperationEventsPaginator) HasMorePages ¶
func (p *ListOperationEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOperationEventsPaginator) NextPage ¶
func (p *ListOperationEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOperationEventsOutput, error)
NextPage retrieves the next ListOperationEvents page.
type ListOperationEventsPaginatorOptions ¶
type ListOperationEventsPaginatorOptions struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. // // If you do not specify a value for MaxResults , the request returns 50 items per // page by default. 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 }
ListOperationEventsPaginatorOptions is the paginator options for ListOperationEvents
type ListOperationsAPIClient ¶
type ListOperationsAPIClient interface {
ListOperations(context.Context, *ListOperationsInput, ...func(*Options)) (*ListOperationsOutput, error)
}
ListOperationsAPIClient is a client that implements the ListOperations operation.
type ListOperationsInput ¶
type ListOperationsInput struct { // The ID of the application. // // This member is required. ApplicationId *string // The filters of an operation. Filters []types.Filter // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If you // do not specify a value for MaxResults, the request returns 50 items per page by // default. MaxResults *int32 // The token for the next page of results. NextToken *string // contains filtered or unexported fields }
type ListOperationsOutput ¶
type ListOperationsOutput struct { // The token to use to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string // List of operations performed by AWS Systems Manager for SAP. Operations []types.Operation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOperationsPaginator ¶
type ListOperationsPaginator struct {
// contains filtered or unexported fields
}
ListOperationsPaginator is a paginator for ListOperations
func NewListOperationsPaginator ¶
func NewListOperationsPaginator(client ListOperationsAPIClient, params *ListOperationsInput, optFns ...func(*ListOperationsPaginatorOptions)) *ListOperationsPaginator
NewListOperationsPaginator returns a new ListOperationsPaginator
func (*ListOperationsPaginator) HasMorePages ¶
func (p *ListOperationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOperationsPaginator) NextPage ¶
func (p *ListOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOperationsOutput, error)
NextPage retrieves the next ListOperations page.
type ListOperationsPaginatorOptions ¶
type ListOperationsPaginatorOptions struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. If you // do not specify a value for MaxResults, the request returns 50 items per page by // default. 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 }
ListOperationsPaginatorOptions is the paginator options for ListOperations
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 PutResourcePermissionInput ¶
type PutResourcePermissionInput struct { // // // This member is required. ActionType types.PermissionActionType // // // This member is required. ResourceArn *string // // // This member is required. SourceResourceArn *string // contains filtered or unexported fields }
type PutResourcePermissionOutput ¶
type PutResourcePermissionOutput struct { // Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RegisterApplicationInput ¶
type RegisterApplicationInput struct { // The ID of the application. // // This member is required. ApplicationId *string // The type of the application. // // This member is required. ApplicationType types.ApplicationType // The Amazon EC2 instances on which your SAP application is running. // // This member is required. Instances []string // The credentials of the SAP application. Credentials []types.ApplicationCredential // The Amazon Resource Name of the SAP HANA database. DatabaseArn *string // The SAP instance number of the application. SapInstanceNumber *string // The System ID of the application. Sid *string // The tags to be attached to the SAP application. Tags map[string]string // contains filtered or unexported fields }
type RegisterApplicationOutput ¶
type RegisterApplicationOutput struct { // The application registered with AWS Systems Manager for SAP. Application *types.Application // The ID of the operation. OperationId *string // 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 StartApplicationInput ¶
type StartApplicationInput struct { // The ID of the application. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type StartApplicationOutput ¶
type StartApplicationOutput struct { // The ID of the operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartApplicationRefreshInput ¶
type StartApplicationRefreshInput struct { // The ID of the application. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
type StartApplicationRefreshOutput ¶
type StartApplicationRefreshOutput struct { // The ID of the operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopApplicationInput ¶
type StopApplicationInput struct { // The ID of the application. // // This member is required. ApplicationId *string // Boolean. If included and if set to True , the StopApplication operation will // shut down the associated Amazon EC2 instance in addition to the application. IncludeEc2InstanceShutdown *bool // Specify the ConnectedEntityType . Accepted type is DBMS . // // If this parameter is included, the connected DBMS (Database Management System) // will be stopped. StopConnectedEntity types.ConnectedEntityType // contains filtered or unexported fields }
type StopApplicationOutput ¶
type StopApplicationOutput struct { // The ID of the operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // Adds/updates or removes credentials for applications registered with AWS // Systems Manager for SAP. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateApplicationSettingsInput ¶
type UpdateApplicationSettingsInput struct { // The ID of the application. // // This member is required. ApplicationId *string // Installation of AWS Backint Agent for SAP HANA. Backint *types.BackintConfig // The credentials to be added or updated. CredentialsToAddOrUpdate []types.ApplicationCredential // The credentials to be removed. CredentialsToRemove []types.ApplicationCredential // The Amazon Resource Name of the SAP HANA database that replaces the current SAP // HANA connection with the SAP_ABAP application. DatabaseArn *string // contains filtered or unexported fields }
type UpdateApplicationSettingsOutput ¶
type UpdateApplicationSettingsOutput struct { // The update message. Message *string // The IDs of the operations. OperationIds []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_DeleteResourcePermission.go
- api_op_DeregisterApplication.go
- api_op_GetApplication.go
- api_op_GetComponent.go
- api_op_GetDatabase.go
- api_op_GetOperation.go
- api_op_GetResourcePermission.go
- api_op_ListApplications.go
- api_op_ListComponents.go
- api_op_ListDatabases.go
- api_op_ListOperationEvents.go
- api_op_ListOperations.go
- api_op_ListTagsForResource.go
- api_op_PutResourcePermission.go
- api_op_RegisterApplication.go
- api_op_StartApplication.go
- api_op_StartApplicationRefresh.go
- api_op_StopApplication.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateApplicationSettings.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go