package mobile
import "github.com/aws/aws-sdk-go-v2/service/mobile"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)
- func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)
- func (c *Client) DescribeBundle(ctx context.Context, params *DescribeBundleInput, optFns ...func(*Options)) (*DescribeBundleOutput, error)
- func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)
- func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, optFns ...func(*Options)) (*ExportBundleOutput, error)
- func (c *Client) ExportProject(ctx context.Context, params *ExportProjectInput, optFns ...func(*Options)) (*ExportProjectOutput, error)
- func (c *Client) ListBundles(ctx context.Context, params *ListBundlesInput, optFns ...func(*Options)) (*ListBundlesOutput, error)
- func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)
- func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)
- type CreateProjectInput
- type CreateProjectOutput
- type DeleteProjectInput
- type DeleteProjectOutput
- type DescribeBundleInput
- type DescribeBundleOutput
- type DescribeProjectInput
- type DescribeProjectOutput
- type EndpointResolver
- type EndpointResolverFunc
- type ExportBundleInput
- type ExportBundleOutput
- type ExportProjectInput
- type ExportProjectOutput
- type HTTPClient
- type HTTPSignerV4
- type ListBundlesInput
- type ListBundlesOutput
- type ListProjectsInput
- type ListProjectsOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type UpdateProjectInput
- type UpdateProjectOutput
Constants ¶
const ServiceAPIVersion = "2017-07-01"
const ServiceID = "Mobile"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.
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) CreateProject ¶
func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)
Creates an AWS Mobile Hub project.
func (*Client) DeleteProject ¶
func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)
Delets a project in AWS Mobile Hub.
func (*Client) DescribeBundle ¶
func (c *Client) DescribeBundle(ctx context.Context, params *DescribeBundleInput, optFns ...func(*Options)) (*DescribeBundleOutput, error)
Get the bundle details for the requested bundle id.
func (*Client) DescribeProject ¶
func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)
Gets details about a project in AWS Mobile Hub.
func (*Client) ExportBundle ¶
func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, optFns ...func(*Options)) (*ExportBundleOutput, error)
Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
func (*Client) ExportProject ¶
func (c *Client) ExportProject(ctx context.Context, params *ExportProjectInput, optFns ...func(*Options)) (*ExportProjectOutput, error)
Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.
func (*Client) ListBundles ¶
func (c *Client) ListBundles(ctx context.Context, params *ListBundlesInput, optFns ...func(*Options)) (*ListBundlesOutput, error)
List all available bundles.
func (*Client) ListProjects ¶
func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)
Lists projects in AWS Mobile Hub.
func (*Client) UpdateProject ¶
func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)
Update an existing project.
type CreateProjectInput ¶
type CreateProjectInput struct { // Default region where project resources should be created. Region *string // ZIP or YAML file which contains configuration settings to be used when creating // the project. This may be the contents of the file downloaded from the URL // provided in an export project operation. Contents []byte // Unique identifier for an exported snapshot of project configuration. This // snapshot identifier is included in the share URL when a project is exported. SnapshotId *string // Name of the project. Name *string }
Request structure used to request a project be created.
type CreateProjectOutput ¶
type CreateProjectOutput struct { // Detailed information about the created AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used in response to a request to create a project.
type DeleteProjectInput ¶
type DeleteProjectInput struct { // Unique project identifier. // // This member is required. ProjectId *string }
Request structure used to request a project be deleted.
type DeleteProjectOutput ¶
type DeleteProjectOutput struct { // Resources which were deleted. DeletedResources []*types.Resource // Resources which were not deleted, due to a risk of losing potentially important // data or files. OrphanedResources []*types.Resource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used in response to request to delete a project.
type DescribeBundleInput ¶
type DescribeBundleInput struct { // Unique bundle identifier. // // This member is required. BundleId *string }
Request structure to request the details of a specific bundle.
type DescribeBundleOutput ¶
type DescribeBundleOutput struct { // The details of the bundle. Details *types.BundleDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure contains the details of the bundle.
type DescribeProjectInput ¶
type DescribeProjectInput struct { // Unique project identifier. // // This member is required. ProjectId *string // If set to true, causes AWS Mobile Hub to synchronize information from other // services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub // project. SyncFromResources *bool }
Request structure used to request details about a project.
type DescribeProjectOutput ¶
type DescribeProjectOutput struct { // Detailed information about an AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used for requests of project details.
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type ExportBundleInput ¶
type ExportBundleInput struct { // Unique project identifier. ProjectId *string // Unique bundle identifier. // // This member is required. BundleId *string // Developer desktop or target application platform. Platform types.Platform }
Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources.
type ExportBundleOutput ¶
type ExportBundleOutput struct { // URL which contains the custom-generated SDK and tool packages used to integrate // the client mobile app or web app with the AWS resources created by the AWS // Mobile Hub project. DownloadUrl *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources.
type ExportProjectInput ¶
type ExportProjectInput struct { // Unique project identifier. // // This member is required. ProjectId *string }
Request structure used in requests to export project configuration details.
type ExportProjectOutput ¶
type ExportProjectOutput struct { // Unique identifier for the exported snapshot of the project configuration. This // snapshot identifier is included in the share URL. SnapshotId *string // URL which can be used to download the exported project configuation file(s). DownloadUrl *string // URL which can be shared to allow other AWS users to create their own project in // AWS Mobile Hub with the same configuration as the specified project. This URL // pertains to a snapshot in time of the project configuration that is created when // this API is called. If you want to share additional changes to your project // configuration, then you will need to create and share a new snapshot by calling // this method again. *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used for requests to export project configuration details.
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListBundlesInput ¶
type ListBundlesInput struct { // Maximum number of records to list in a single response. MaxResults *int32 // Pagination token. Set to null to start listing bundles from start. If non-null // pagination token is returned in a result, then pass its value in here in another // request to list more bundles. NextToken *string }
Request structure to request all available bundles.
type ListBundlesOutput ¶
type ListBundlesOutput struct { // Pagination token. If non-null pagination token is returned in a result, then // pass its value in another request to fetch more entries. NextToken *string // A list of bundles. BundleList []*types.BundleDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure contains a list of all available bundles with details.
type ListProjectsInput ¶
type ListProjectsInput struct { // Maximum number of records to list in a single response. MaxResults *int32 // Pagination token. Set to null to start listing projects from start. If non-null // pagination token is returned in a result, then pass its value in here in another // request to list more projects. NextToken *string }
Request structure used to request projects list in AWS Mobile Hub.
type ListProjectsOutput ¶
type ListProjectsOutput struct { // Pagination token. Set to null to start listing records from start. If non-null // pagination token is returned in a result, then pass its value in here in another // request to list more entries. NextToken *string // List of projects. Projects []*types.ProjectSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used for requests to list projects in AWS Mobile Hub.
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 credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
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 ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type UpdateProjectInput ¶
type UpdateProjectInput struct { // ZIP or YAML file which contains project configuration to be updated. This should // be the contents of the file downloaded from the URL provided in an export // project operation. Contents []byte // Unique project identifier. // // This member is required. ProjectId *string }
Request structure used for requests to update project configuration.
type UpdateProjectOutput ¶
type UpdateProjectOutput struct { // Detailed information about the updated AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Result structure used for requests to updated project configuration.
Source Files ¶
api_client.go api_op_CreateProject.go api_op_DeleteProject.go api_op_DescribeBundle.go api_op_DescribeProject.go api_op_ExportBundle.go api_op_ExportProject.go api_op_ListBundles.go api_op_ListProjects.go api_op_UpdateProject.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 25 packages
- Last checked
- now –
Tools for package owners.